Add live docs rebuilding using sphinx-autobuild #916
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a new tox target, `livedocs`, that uses sphinx-autobuild to monitor the docs and auto rebuild the HTML docs when they change. It also starts a webserver on 127.0.0.1:8000 using livereload to serve the docs, which will automatically reload the pages in your browser as they are changed. Add docs on updating the docs. Add sphinx-rtd-theme so that the docs generated in development match the style that they are displayed in on readthedocs.
Codecov Report
@@ Coverage Diff @@
## master #916 +/- ##
=======================================
Coverage 95.04% 95.04%
=======================================
Files 25 25
Lines 1070 1070
=======================================
Hits 1017 1017
Misses 53 53 Continue to review full report at Codecov.
|
This was referenced Mar 15, 2021
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a new tox target,
livedocs, that usessphinx-autobuildto monitor the docs and auto rebuild the HTML docs when they change.It also starts a webserver on 127.0.0.1:8000 using
livereloadto serve the docs, which will automatically reload the pages in your browser as they are changed.Add docs on updating the docs.
Add
sphinx-rtd-themeso that the docs generated in development match the style that they are displayed in on readthedocs.This shouldn't affect test run time; the
livedocstox target is only run when explicitly asked for, and packages are only installed when usinglivedocsDescription of the Change
Checklist
CHANGELOG.mdupdated (only for user relevant changes)AUTHORS