|
@@ -141,6 +141,9 @@ Here is an example which makes a complete rebuild:
|
|
|
live build
|
|
|
----------
|
|
|
|
|
|
+.. _sphinx-autobuild:
|
|
|
+ https://github.com/executablebooks/sphinx-autobuild/blob/master/README.md
|
|
|
+
|
|
|
.. sidebar:: docs-clean
|
|
|
|
|
|
It is recommended to assert a complete rebuild before deploying (use
|
|
@@ -156,9 +159,21 @@ changed.
|
|
|
$ make docs-live
|
|
|
...
|
|
|
The HTML pages are in dist/docs.
|
|
|
- ... Serving on http://0.0.0.0:8080
|
|
|
+ ... Serving on http://0.0.0.0:8000
|
|
|
... Start watching changes
|
|
|
|
|
|
+Live builds are implemented by sphinx-autobuild_. Use environment
|
|
|
+``$(SPHINXOPTS)`` to pass arguments to the sphinx-autobuild_ command. Except
|
|
|
+option ``--host`` (which is always set to ``0.0.0.0``) you can pass any
|
|
|
+argument. E.g to find and use a free port, use:
|
|
|
+
|
|
|
+.. code:: sh
|
|
|
+
|
|
|
+ $ SPHINXOPTS="--port 0" make docs-live
|
|
|
+ ...
|
|
|
+ ... Serving on http://0.0.0.0:50593
|
|
|
+ ...
|
|
|
+
|
|
|
|
|
|
.. _deploy on github.io:
|
|
|
|