graspologic icon indicating copy to clipboard operation
graspologic copied to clipboard

Expand Reference table of contents one more level

Open bdpedigo opened this issue 5 years ago • 3 comments

Is your feature request related to a problem? Please describe.

Currently in reference tab in docs, it looks like

Reference | |_____ Module 1 | |____ Topic 1 | |____ Topic 2 | |_____ Module 2 | |____ Topic 1 | |____ Topic 2 ...

So none of the actual classes/functions can be seen in the TOC.

I dislike this. I know many people miss certain functions because they don't scroll through everything in the actual page.

Screen Shot 2020-12-03 at 11 00 38 AM

Describe the solution you'd like

I would like each function/class to show up in the TOC (basically just make it go one level further). I'd be okay with removing the intermediate categorizations that don't correspond to an actual module or anything like that.

Describe alternatives you've considered

Some libraries have something like this or this

Additional context

Seems related to #119 Is a solution to something I think @jovo was complaining about.

Would like to hear opinions on this.

bdpedigo avatar Dec 03 '20 16:12 bdpedigo

Both seem options appropriate to me; removing the intermediate categorizations seem more user-friendly than nesting them, but both have pros and cons obviously.

alyakin314 avatar Dec 05 '20 18:12 alyakin314

i also wanted to add in that it might be time for us to re-arrange references in some sort of a logical order

alyakin314 avatar Dec 05 '20 18:12 alyakin314

https://scanpy.readthedocs.io/en/stable/api/index.html#module-scanpy.tl curious what people think of this as a way of organizing the reference docs

bdpedigo avatar Mar 26 '21 01:03 bdpedigo