diff --git a/README.rst b/README.rst index 599be0e..c6d125a 100644 --- a/README.rst +++ b/README.rst @@ -22,3 +22,7 @@ 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`` + + +For continuous rebuilds and live-reload in the browser while editing the docs, run `sphinx-autobuild docs/source docs/build/html --open-browser` + diff --git a/docs/source/conf.py b/docs/source/conf.py index 1ed3705..da8d144 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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'] diff --git a/requirements-dev.in b/requirements-dev.in index 4434a22..0fe5cc4 100644 --- a/requirements-dev.in +++ b/requirements-dev.in @@ -1,2 +1,3 @@ sphinx guzzle-sphinx-theme +sphinx-autobuild diff --git a/requirements-dev.txt b/requirements-dev.txt index f739e42..9edaa67 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile +# This file is autogenerated by pip-compile with python 3.9 # To update, run: # # pip-compile --output-file=requirements-dev.txt requirements-dev.in @@ -12,6 +12,8 @@ certifi==2020.12.5 # via requests chardet==4.0.0 # via requests +colorama==0.4.4 + # via sphinx-autobuild docutils==0.17.1 # via sphinx guzzle-sphinx-theme==0.7.11 @@ -22,6 +24,8 @@ imagesize==1.2.0 # via sphinx jinja2==3.0.1 # via sphinx +livereload==2.6.3 + # via sphinx-autobuild markupsafe==2.0.1 # via jinja2 packaging==20.9 @@ -34,12 +38,17 @@ pytz==2021.1 # via babel requests==2.25.1 # via sphinx +six==1.16.0 + # via livereload snowballstemmer==2.1.0 # via sphinx sphinx==4.0.2 # via # -r requirements-dev.in # guzzle-sphinx-theme + # sphinx-autobuild +sphinx-autobuild==2021.3.14 + # via -r requirements-dev.in sphinxcontrib-applehelp==1.0.2 # via sphinx sphinxcontrib-devhelp==1.0.2 @@ -52,6 +61,8 @@ sphinxcontrib-qthelp==1.0.3 # via sphinx sphinxcontrib-serializinghtml==1.1.5 # via sphinx +tornado==6.1 + # via livereload urllib3==1.26.4 # via requests