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

Clean up docs #680

Open
3 tasks
hammer opened this issue Sep 20, 2021 · 1 comment
Open
3 tasks

Clean up docs #680

hammer opened this issue Sep 20, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@hammer
Copy link
Contributor

hammer commented Sep 20, 2021

While working on #504 I noticed a few things that make the docs look cleaner, in my opinion. I'm curious to hear from others.

  • Remove Indices and tables section from index.rst. The index takes a while to build and seems primarily useful in a book context. We have a search box, that seems more useful to me.
  • Remove the "fullscreen" and "download" links on every page. The browser can handle these functions.
  • Remove the table of contents at the top of each page. The theme includes a right sidebar with a table of contents already, no need to duplicate this content and push page content down.
@hammer hammer added the documentation Improvements or additions to documentation label Sep 20, 2021
@hammer hammer self-assigned this Sep 20, 2021
@hammer hammer mentioned this issue Sep 20, 2021
@hammer
Copy link
Contributor Author

hammer commented Sep 20, 2021

It turns out the right sidebar is not shown on mobile, so the TOC on each page could plausibly stay. I would still recommend we get rid of it, though, as it's quite large and not usually what the user wants.

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

Successfully merging a pull request may close this issue.

1 participant