Live reload #2
Live reload #2
Conversation
torotil
left a comment
torotil
left a comment
There was a problem hiding this comment.
Thanks for documenting how to do auto-builds. Could you update the PR according to the review comments?
README.rst
Outdated
| 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 | ||
| guzzle-sphinx-theme | ||
| sphinx-autobuild | ||
| sphinx-autobuild |
There was a problem hiding this comment.
Could you squash this fixup commit into the one that adds this line?
.gitignore
Outdated
| 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.
| # 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?
This PR adds live-reload and continuous building while editing the docs
This makes it easier to preview your changes