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

Readme should include how to install sphinx-rtd-theme #319

Closed
iandobbie opened this issue Oct 11, 2023 · 0 comments · Fixed by #336
Closed

Readme should include how to install sphinx-rtd-theme #319

iandobbie opened this issue Oct 11, 2023 · 0 comments · Fixed by #336

Comments

@iandobbie
Copy link

If you try to build the docs locally with sphinx as suggested in the README you need to install the sphinx-rtd-theme as well as sphinx. This should probably be added to the readme.

eg

 It can be built locally with::
 
    $ pip install sphinx
    $ pip install sphinx-rtd-theme
    $ sphinx-build -b html docs/source/ docs/build/html
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

Successfully merging a pull request may close this issue.

1 participant