Merge "Build sphinx doc automatically on changes"

2017-11-23 13:57:35 +00:00 · 2017-11-23 13:57:35 +00:00 · 961e8c4048
parent 54b9de34c4 2a3e673f55
commit 961e8c4048
3 changed files with 16 additions and 3 deletions
--- a/README.rst
+++ b/README.rst
@ -61,4 +61,10 @@ confidence in the Jenkins result), please execute the following command::
  $ tox

 After running ``tox``, the documentation will be available for viewing in HTML
-format in the ``doc/build/`` directory.
+format in the ``doc/build/`` directory.
+
+To build the document automatically on changes, use the command::
+
+  $ tox -e autobuild
+
+Then open in a browser http://localhost:8000
--- a/requirements.txt
+++ b/requirements.txt
@ -7,4 +7,5 @@ sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
 graphviz>=0.4,!=0.5.0  # MIT License
 testrepository>=0.0.18
 testtools>=0.9.34
-yasfb
+yasfb
+sphinx-autobuild
--- a/tox.ini
+++ b/tox.ini
@ -18,4 +18,10 @@ commands = python setup.py build_sphinx

 [testenv:doc8]
 deps = -r{toxinidir}/requirements.txt doc8
-commands = doc8 doc/source
+commands = doc8 doc/source
+
+[testenv:autobuild]
+whitelist_externals =
+    sphinx-autobuild
+commands =
+    sphinx-autobuild doc/source doc/build