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.

Sign up for GitHub

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

Jump to bottom

Add config to build HTML documentation with Sphinx #212

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Add config to build HTML documentation with Sphinx #212

wants to merge 2 commits into from
+132 −6

Conversation

JWCook
Copy link

@JWCook JWCook commented Dec 21, 2020 •
edited

Closes #211

To preview the docs before publishing to ReadTheDocs, run:

pip install ".[docs]"
make -C docs html

Then open docs/_build/html/index.html.

@JWCook JWCook marked this pull request as ready for review December 21, 2020 18:15
@JWCook JWCook mentioned this pull request Dec 21, 2020
Open
@coveralls
Copy link

Coverage Status

Coverage remained the same at 87.752% when pulling 51130c8 on JWCook:sphinx-docs into c3579ba on tkrajina:dev.

@JWCook
Copy link
Author

JWCook commented May 20, 2022

@tkrajina Any issues merging this in?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Build Sphinx documentation and host on ReadTheDocs
2 participants
@JWCook @coveralls