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

Live reload #2

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Live reload #2

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
cfaee5b
add .vscode dir to gitignore
edjw May 5, 2022
ec287b0
add sphinx-autobuild for live-reloading
edjw May 5, 2022
20465bf
comment out html_static_path in conf.py to stop sphinx-autoreload com…
edjw May 5, 2022
72f9114
add description of how to run livereload to readme
edjw May 5, 2022
c15a6f2
add new line to end of requirements-dev.in to stop github pr interfac…
edjw May 6, 2022
fbf04ea
Revert "add .vscode dir to gitignore"
edjw May 12, 2022
45aad0d
add .vscode dir to gitignore
edjw May 5, 2022
7b07014
add sphinx-autobuild for live-reloading
edjw May 5, 2022
353bb3d
comment out html_static_path in conf.py to stop sphinx-autoreload com…
edjw May 5, 2022
24d1c2e
add description of how to run livereload to readme
edjw May 5, 2022
229ed1d
add new line to end of requirements-dev.in to stop github pr interfac…
edjw May 6, 2022
2d97c53
Merge branch 'live-reload' of https://github.com/moreonion/impact-sta…
edjw May 12, 2022
28ff43f
remove .vscode from .gitignore
edjw May 12, 2022
b1577d7
move continuous rebuild instruction to its own section
edjw May 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ Writing documentation
---------------------

1. Edit the source files in ``docs/source``.
2. Build the HTML version using ``make html`` (in the ``docs`` folder).
3. View the result in your browser in ``docs/build``
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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

4. View the result in your browser in ``docs/build``