Hi everyone, I would like to propose to slim down the side bar on the API pages. At the moment, we have a long list which includes most/all submodules as well. I would propose to remove all submodules to only keep top level modules. From the analytics, we have around 10% of our viewer using small screens and for them the experience is very bad. (Even when we will be able to new versions of the theme which improve the situation, it would still be a long list to go through.) Still from analytics, most of the exit pages are not from submodules. Hence I think the impact on readers of the doc should be minimal (see image attached, and stats are similar for individual page count and entry pages). In the following PR, we removed the stats submodules to only keep stats in the side bar. We thing it’s cleaner. (We originally started to look into this as we wanted to remove things like result classes mentions.) https://github.com/scipy/scipy/pull/17876 If there is no objections, I would make a follow up PR to do the change. See the attached images for a preview of how it would look like. Cheers, Pamphile 
On Sat, Jan 28, 2023 at 9:37 PM Stefan van der Walt <stefanv@berkeley.edu> wrote:
On Sat, Jan 28, 2023, at 13:05, Pamphile Roy wrote:
At the moment, we have a long list which includes most/all submodules as well. I would propose to remove all submodules to only keep top level modules.
That looks like a clear improvement; thanks.
It looks like only a minor gain. What would be much more effective I think is to only list the module names in the sidebar. That will be a lot more readable because every entry will be one line and because all submodules will line up nicely. WDYT? Cheers, Ralf
On Sat, Jan 28, 2023, at 15:40, Ralf Gommers wrote:
On Sat, Jan 28, 2023 at 9:37 PM Stefan van der Walt <stefanv@berkeley.edu> wrote:
__ On Sat, Jan 28, 2023, at 13:05, Pamphile Roy wrote:
At the moment, we have a long list which includes most/all submodules as well. I would propose to remove all submodules to only keep top level modules.
That looks like a clear improvement; thanks.
It looks like only a minor gain. What would be much more effective I think is to only list the module names in the sidebar. That will be a lot more readable because every entry will be one line and because all submodules will line up nicely.
I'm trying to understand how what you're proposing is different from Pamphile's quote above. Sorry for being dense! Perhaps you mean Pamphile's suggestion but also removing any extra text? Stéfan
On Sat, Jan 28, 2023 at 11:52 PM Stefan van der Walt <stefanv@berkeley.edu> wrote:
On Sat, Jan 28, 2023, at 15:40, Ralf Gommers wrote:
On Sat, Jan 28, 2023 at 9:37 PM Stefan van der Walt <stefanv@berkeley.edu> wrote:
On Sat, Jan 28, 2023, at 13:05, Pamphile Roy wrote:
At the moment, we have a long list which includes most/all submodules as well. I would propose to remove all submodules to only keep top level modules.
That looks like a clear improvement; thanks.
It looks like only a minor gain. What would be much more effective I think is to only list the module names in the sidebar. That will be a lot more readable because every entry will be one line and because all submodules will line up nicely.
I'm trying to understand how what you're proposing is different from Pamphile's quote above. Sorry for being dense!
Perhaps you mean Pamphile's suggestion but also removing any extra text?
Yes indeed - sidebar content would be: scipy.cluster scipy.constants scipy.datasets ... The extra text and then the module name in brackets is very messy and the text adds very little. Ralf
Stéfan _______________________________________________ SciPy-Dev mailing list -- scipy-dev@python.org To unsubscribe send an email to scipy-dev-leave@python.org https://mail.python.org/mailman3/lists/scipy-dev.python.org/ Member address: ralf.gommers@googlemail.com
I agree, this looks like a clear improvement. Thanks! On Sun, 29 Jan 2023 at 08:04, Stefan van der Walt <stefanv@berkeley.edu> wrote:
On Sat, Jan 28, 2023, at 15:56, Ralf Gommers wrote:
Yes indeed - sidebar content would be:
scipy.cluster scipy.constants scipy.datasets ...
The extra text and then the module name in brackets is very messy and the text adds very little.
Agreed, thanks for clarifying!
Stéfan
_______________________________________________ SciPy-Dev mailing list -- scipy-dev@python.org To unsubscribe send an email to scipy-dev-leave@python.org https://mail.python.org/mailman3/lists/scipy-dev.python.org/ Member address: kaistriega+python@gmail.com
Hi The last years, I used the scipy API docs a lot and this proposal really improves the page navigation. So thanks a lot for the initiative. Best Christian
participants (5)
-
Christian Lorentzen -
Kai Striega -
Pamphile Roy -
Ralf Gommers -
Stefan van der Walt