From e697d78d5a907014252df9aec79d981b800aac91 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 29 Oct 2020 13:31:11 +0100 Subject: [mod] make docs-live - remove --port option from sphinx-autobuild Setting port fixed to 8080 has drawbacks when this port is already in use from another application [1]. Removing this option from the command line offers the use of the sphinx-autobuild defaults which are much more flexible [2]. [1] https://github.com/searx/searx/issues/2282 [2] https://github.com/executablebooks/sphinx-autobuild/blob/master/README.md Signed-off-by: Markus Heiser --- docs/dev/contribution_guide.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'docs/dev/contribution_guide.rst') diff --git a/docs/dev/contribution_guide.rst b/docs/dev/contribution_guide.rst index 5012dea21..26f8d2bb7 100644 --- a/docs/dev/contribution_guide.rst +++ b/docs/dev/contribution_guide.rst @@ -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: -- cgit v1.2.3