sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.47k stars 2.1k forks source link

multi level view for python module index page #9854

Open hashimx opened 2 years ago

hashimx commented 2 years ago

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

I would like to make the python module index more friendly to users by adding more levels of expanding and colliding the module API. currently, there is only one level and I'm not sure how to enable more levels

Describe the solution you'd like A clear and concise description of what you want to happen.

I would like a solution like below

in current solution it looks like

tk0miya commented 2 years ago

Thank you for proposal. But I can't understand your request well. Could you explain it in detail? I need to know what "GRAND PARENT API", "PARENT API", "CHILD API" means actually.

hashimx commented 2 years ago

Hi , @tk0miya

Thank you for your response , what I mean is this, currently the python module index looks like below

-some x API module some y API module under x some z API module under x some a API moduke under x ......

-some b API module some c API module under b some d API module under b some e API module under b .......

Now, if I click on the "-" symbol the information is collapsed and view becomes like this

+some x API module +some b API module

My Requirement is: "some y API module under x" is having more API's under it, those API's are not listed in python module index. How can I make them list in this view so that I can expand and collapse "some y API module under x", so that the view can become.

-some x API module -some y API module under x some e API under y under x some f API under y under x

Hope my requirement is clear. sorry for formatting , seems github editing is not proper

Thank You

hashimx commented 2 years ago

Hi @tk0miya

Any update on this request please?