From cfaee5bd1f7834c9140adcd8293d4ca893b57ec7 Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 5 May 2022 19:53:03 +0100 Subject: [PATCH 01/13] add .vscode dir to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 2f63bb0..f466a9b 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ __pycache__ coverage.xml .pytest_cache/ docs/build +.vscode From ec287b0ff50ba129f586e0d3c7d59f1a869d34e0 Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 5 May 2022 20:02:34 +0100 Subject: [PATCH 02/13] add sphinx-autobuild for live-reloading of docs for easy editing --- requirements-dev.in | 1 + requirements-dev.txt | 13 ++++++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/requirements-dev.in b/requirements-dev.in index 4434a22..6b3d341 100644 --- a/requirements-dev.in +++ b/requirements-dev.in @@ -1,2 +1,3 @@ sphinx guzzle-sphinx-theme +sphinx-autobuild \ No newline at end of file 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 From 20465bf600989978e2d43030598deb898c104e87 Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 5 May 2022 20:03:10 +0100 Subject: [PATCH 03/13] comment out html_static_path in conf.py to stop sphinx-autoreload complaining --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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'] From 72f911408cd5dbe459d61e6c65a0c10fd7da64f0 Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 5 May 2022 20:08:57 +0100 Subject: [PATCH 04/13] add description of how to run livereload to readme --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 599be0e..efa0e8a 100644 --- a/README.rst +++ b/README.rst @@ -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). +4. View the result in your browser in ``docs/build`` From c15a6f23175bcde9c1962c62b1974866d2777e4b Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Fri, 6 May 2022 11:30:08 +0100 Subject: [PATCH 05/13] add new line to end of requirements-dev.in to stop github pr interface complaining --- requirements-dev.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements-dev.in b/requirements-dev.in index 6b3d341..0fe5cc4 100644 --- a/requirements-dev.in +++ b/requirements-dev.in @@ -1,3 +1,3 @@ sphinx guzzle-sphinx-theme -sphinx-autobuild \ No newline at end of file +sphinx-autobuild From fbf04eacc722ff8cb99dbc0f4f6f5ffe65e0e7fc Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 12 May 2022 12:47:20 +0100 Subject: [PATCH 06/13] Revert "add .vscode dir to gitignore" This reverts commit cfaee5bd1f7834c9140adcd8293d4ca893b57ec7. --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index f466a9b..2f63bb0 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,3 @@ __pycache__ coverage.xml .pytest_cache/ docs/build -.vscode From 45aad0d327e80f8f88c8492872223f327697c2d4 Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 5 May 2022 19:53:03 +0100 Subject: [PATCH 07/13] add .vscode dir to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 2f63bb0..f466a9b 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ __pycache__ coverage.xml .pytest_cache/ docs/build +.vscode From 7b07014df476787ca577a20ba17bb06f712f0610 Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 5 May 2022 20:02:34 +0100 Subject: [PATCH 08/13] add sphinx-autobuild for live-reloading of docs for easy editing --- requirements-dev.in | 1 + requirements-dev.txt | 13 ++++++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/requirements-dev.in b/requirements-dev.in index 4434a22..6b3d341 100644 --- a/requirements-dev.in +++ b/requirements-dev.in @@ -1,2 +1,3 @@ sphinx guzzle-sphinx-theme +sphinx-autobuild \ No newline at end of file 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 From 353bb3da645c869091443ba3c6635029c5bb2a31 Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 5 May 2022 20:03:10 +0100 Subject: [PATCH 09/13] comment out html_static_path in conf.py to stop sphinx-autoreload complaining --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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'] From 24d1c2eb8ba570aef158666aa0e4ee13832a4c18 Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 5 May 2022 20:08:57 +0100 Subject: [PATCH 10/13] add description of how to run livereload to readme --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 599be0e..efa0e8a 100644 --- a/README.rst +++ b/README.rst @@ -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). +4. View the result in your browser in ``docs/build`` From 229ed1d33b9687f4f60a57408520c514510ac207 Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Fri, 6 May 2022 11:30:08 +0100 Subject: [PATCH 11/13] add new line to end of requirements-dev.in to stop github pr interface complaining --- requirements-dev.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements-dev.in b/requirements-dev.in index 6b3d341..0fe5cc4 100644 --- a/requirements-dev.in +++ b/requirements-dev.in @@ -1,3 +1,3 @@ sphinx guzzle-sphinx-theme -sphinx-autobuild \ No newline at end of file +sphinx-autobuild From 28ff43f400e725c20a97c427c5cdcb89f12e652f Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 12 May 2022 12:58:59 +0100 Subject: [PATCH 12/13] remove .vscode from .gitignore --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index f466a9b..2f63bb0 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,3 @@ __pycache__ coverage.xml .pytest_cache/ docs/build -.vscode From b1577d74a696b6472afb1079005a41f1790abccf Mon Sep 17 00:00:00 2001 From: Ed Johnson-Williams Date: Thu, 12 May 2022 13:00:36 +0100 Subject: [PATCH 13/13] move continuous rebuild instruction to its own section --- README.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index efa0e8a..c6d125a 100644 --- a/README.rst +++ b/README.rst @@ -20,6 +20,9 @@ Writing documentation --------------------- 1. Edit the source files in ``docs/source``. -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). -4. View the result in your browser in ``docs/build`` +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` +