Read the docs does not show full table of contents of left bar + font improvement

[Munfred]

Hello, I have a minor suggestion that I think will be very helpful for people to navigate and read the documentation.

Right now Read the Docs does not display the full table of contents on the left (i.e. one link for every page).
For example, to go to the page on scanpy.api.pp.calculate_qc_metrics (which is https://scanpy.readthedocs.io/en/latest/api/scanpy.api.pp.calculate_qc_metrics.html) I have two options:

First, I could go to the API page under prepocessing (https://scanpy.readthedocs.io/en/latest/api/index.html#preprocessing-pp) , and click the link to pp.calculate_qc_metrics link highlighted in the picture. However, it's not clear from the font used that it's clickable, because it looks like just markdown. I'd suggest making links blue, or underlined, or both, because that's what will convey that they are clickable

Second, at the bottom of the page I could click next, which will take me to the next page. This only allows me to navigate the pages sequentially, and is not very practical because I don't know what comes next.

It would be extremely helpful for people navigating the doc if the table of contents unfurled into links for the individual pages contained in the section they are at. I made an example below of what I think this could look like, in it each page under Preprocessing: PP gets it's own link in the sidebar.

Thanks

Eduardo

[falexwolf]

Thank you for your suggestions! I'm very happy to improve things. We're just right now working on improvements on another branch (beyondapi). I'll get back to this thread in a couple days with the results...

[falexwolf]

This should be fixed via: #407

We're super happy if you check out the new: https://scanpy.readthedocs.io/en/latest/api/ and give us your feedback! We know that we still have an issue with the return sections, which was introduced in the past couple of months as we changed the docs generator. We're working on that.

[Munfred]

The new documentation index looks great! It's exactly what I was thinking about! Thanks so much for being so responsive!

[falexwolf]

Great that you like it! 😄 I'm closing this.