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

New docs theme doesn't show subsections under (for example) pip install #4852

Closed
pfmoore opened this issue Nov 10, 2017 · 3 comments · Fixed by #4855
Closed

New docs theme doesn't show subsections under (for example) pip install #4852

pfmoore opened this issue Nov 10, 2017 · 3 comments · Fixed by #4855
Labels
auto-locked Outdated issues that have been locked by automation type: docs Documentation related

Comments

@pfmoore
Copy link
Member

pfmoore commented Nov 10, 2017

As an example, compare https://pip.pypa.io/en/latest/reference/pip_install/ and https://pip.pypa.io/en/stable/reference/pip_install/

The sidebar for stable shows the subsections Usage, Description, Options and Examples, and Description is expandable another level. And there's a full multi-level table of contents at the top of the page. Both of these features are missing from the new layout, which is a significant regression in navigability.

@pradyunsg pradyunsg added the type: docs Documentation related label Nov 11, 2017
@pradyunsg
Copy link
Member

Which of these do we want to go with:

  • increase the depth of headers in the sidebar
    • just a matter of bumping a number in conf.py
  • add a table of contents on the reference pages
    • just the matter of putting a :contents: on top of the files

I like the first option. Either way, we should increase the depth of the tree in https://pip.pypa.io/en/latest/reference/ to be one step deeper -- like it is in stable.

Making a PR with first...

@pradyunsg
Copy link
Member

Aside -- these changes were made in #4758.

@pfmoore
Copy link
Member Author

pfmoore commented Nov 11, 2017

Does the sidebar have click-to-expand behaviour like the old version, or is the full tree always visible?Personally, I like having both, but if we have to choose just one, I'd go with the sidebar.

Aside -- these changes were made in #4758.

Yeah, sorry I missed the implications then. I was distracted by the text-width thing, I guess :-(

@lock lock bot added the auto-locked Outdated issues that have been locked by automation label Jun 2, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Jun 2, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
auto-locked Outdated issues that have been locked by automation type: docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants