Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: submenus are not collapsed in left sidebar #30

Closed
anarcat opened this issue Apr 26, 2016 · 5 comments
Closed

docs: submenus are not collapsed in left sidebar #30

anarcat opened this issue Apr 26, 2016 · 5 comments

Comments

@anarcat
Copy link

anarcat commented Apr 26, 2016

the table of contents on the documentation site in http://deb-o-matic.readthedocs.io/ seems to lack the normal collapsible items in other table of contents. it seems that all headings are shown in a single flat list instead of the usual collapsible hierarchy. here a screenshot of the behavior here:

image

this is on Chromium in Debian stable: Version 53.0.2785.143 Built on 8.6, running on Debian 8.6 (64-bit). i see the same in Firefox 45.

it could be that is because everything is in a single rst file. rst documents can be split among multiple files, which makes them easier to read from source but also makes it easier to build a proper table of contents. the current rendering on RTD is broken I think because of that. i would suggest making one section per file to clear things up a bit, with index.rst being just an introduction to the package and showing a table of contents. this way, index.rst could also be reused as a README file or better, just include a README file that would sit on top.

@dktrkranz
Copy link
Contributor

Hi @anarcat, can you suggest where the rendering on RDT is broken?

@anarcat
Copy link
Author

anarcat commented Oct 15, 2016

i guess rendering is not "broken", that was a bit of a misfire... i guess the issue here is that I find the table of contents on the left hard to navigate because it is "flat". for example on this browser here, the "Configuration" section is followed by "Configuration file", "debomatic section", and so on, all flattened. Here is a screenshot:

image

when i click the "plus" button, the menu items, oddly enough, all regroup under the submenu and things go back to normal until i click the "minus" button again, going back to the above state.

i will clarify the original report - i was focusing on what i thought the solution was, instead of describing the problem more clearly, apologies.

@anarcat anarcat changed the title split docs in multiple files docs: submenus are not collapsed in left sidebar Oct 15, 2016
@dktrkranz
Copy link
Contributor

@anarcat do you have other examples on readthedocs I can take inspiration from?

@anarcat
Copy link
Author

anarcat commented Jun 20, 2017

@dktrkranz
Copy link
Contributor

Thanks, latest commits should have made the trick, see latest documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants