👷🏻♂️Automate the build and local preview of the website #74
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
ebouchut
force-pushed
the
config/sphinx-autobuild
branch
from
a7d2cd2
to
17df86d
Compare
Rebuild Sphinx documentation on changes, with hot reloading in the browser. See: https://pypi.org/project/sphinx-autobuild/
sphinx-autobuild docs/EN docs/_build/html
ebouchut
force-pushed
the
config/sphinx-autobuild
branch
from
17df86d
to
a8b82cc
Compare
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.
This PR helps automate building and local previewing of the website.
ℹ️ ✅ Launch the below command and keep it running in a dedicated window/tab:
# cd trio-docs sphinx-autobuild docs/EN docs/_build/htmlIt builds the website and runs a local Web server to preview the site live.
Each time you change a file, it rebuilds the website and hot-reloads the pages in the Web browser so that you can see the changes.
You will no longer need to reload the page you modified locally,
sphinx-autobuilddoes it for you automatically.See: https://pypi.org/project/sphinx-autobuild/
❌ You no longer need to rebuild the site each time you update a page:
# cd trio-docs sphinx-build -M html docs/EN/ docs/_build/sphinx-autobuilddependency.trio-docs