Live reload #2
Open
Live reload #2
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
torotil
requested changes
May 6, 2022
README.rst
Outdated
Comment on lines
23
to
24
| 2. For continuous rebuilds and live-reload in the browser while editing the docs, run `sphinx-autobuild docs/source docs/build/html --open-browser` | ||
| 3. Build the HTML version using ``make html`` (in the ``docs`` folder). |
There was a problem hiding this comment.
Putting the info for continuous rebuilds in this list makes it look like this is a necessary step in order to build the docs. I think it should rather go below the enumeration.
| sphinx-autobuild |
There was a problem hiding this comment.
Could you squash this fixup commit into the one that adds this line?
.gitignore
Outdated
| @@ -8,3 +8,4 @@ __pycache__ | |||
| coverage.xml | |||
| .pytest_cache/ | |||
| docs/build | |||
| .vscode | |||
There was a problem hiding this comment.
I think support for particular editors should not be part of this repo. I’d recommend to add a global .gitignore instead that takes vscode into account.
| @@ -57,4 +57,4 @@ | |||
| # Add any paths that contain custom static files (such as style sheets) here, | |||
| # relative to this directory. They are copied after the builtin static files, | |||
| # so a file named "default.css" will overwrite the builtin "default.css". | |||
| html_static_path = ['_static'] | |||
| # html_static_path = ['_static'] | |||
There was a problem hiding this comment.
What is sphinx-autoreload complaining about? Is it because the folder doesn’t exist (yet). Should we just add it as an empty folder to the repo instead?
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 adds live-reload and continuous building while editing the docs
This makes it easier to preview your changes