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

Proposal: Improve navigation with new theme #274

Open
mradamcox opened this issue Jan 31, 2022 · 1 comment
Open

Proposal: Improve navigation with new theme #274

mradamcox opened this issue Jan 31, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@mradamcox
Copy link
Member

describe the issue

This ticket is a proposal to switch themes from the default RTD theme that we've been using to something new with better sidebar navigation and a better capacity for displaying large amounts of content for different audiences, like we do. For example, it would be nice to have more general headers in that menu with expandable content below them. This looks like a good example:

https://pydata-sphinx-theme.readthedocs.io/en/latest/demo/index.html

Also, it may be nice to "freshen" up the documentation with a new theme.

To try this out, a new branch should be made that uses the theme, and that branch should be published to Read The Docs on a hidden build.

which release does this issue concern?

6 + (no need to backport a new theme to older releases.

@mradamcox mradamcox added the enhancement New feature or request label Jan 31, 2022
@dwuthrich
Copy link
Contributor

@mradamcox I like the idea of improving the documentation theme to improve navigation and presentation. Your example looks like a significant improvement over our current UI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants