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: Switch local docs theme to Readthedocs #195

Open
pgagne opened this issue Oct 5, 2020 · 0 comments
Open

Proposal: Switch local docs theme to Readthedocs #195

pgagne opened this issue Oct 5, 2020 · 0 comments

Comments

@pgagne
Copy link
Contributor

pgagne commented Oct 5, 2020

When building docs locally it would be nice to use the same theme as readthedocs so the output looks the same. This seems pretty easy to do:

https://github.com/rtfd/sphinx_rtd_theme

Notes

We should add sphinx-rtd-theme to docs/requirements.txt.

If people are unsure about the added dependency, we should be able to add handling to sphinx conf.py to not set html_theme if sphinx-rtd-theme is not installed. This would result in the default theme being used.

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

No branches or pull requests

1 participant