Skip to content

Commit 6f3024f

Browse files
committed
Add note to docs about usage with sphinx-autobuild
1 parent 67ac825 commit 6f3024f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/configuration.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,18 @@ Tags can be passed in either as arguments or in the body of the directive:
117117
118118
tag1, tag2, tag3,
119119
tag4, tag5, tag6,
120+
121+
Usage with sphinx-autobuild
122+
---------------------------
123+
124+
`Sphinx-autobuild <https://github.com/sphinx-doc/sphinx-autobuild>`_ is a live-reload
125+
tool for local development that automatically rebuilds your docs when changes are
126+
detected. Sphinx-tags dynamically generates a tag overview and tag index pages
127+
during each build, so you will want to tell sphinx-autobuild to ignore these
128+
files so it doesn't get stuck in a loop. Example:
129+
130+
.. code-block:: sh
131+
132+
sphinx-autobuild docs docs/_build/html --ignore '**/_tags/*'
133+
134+
If you have set ``tags_output_dir`` to a different path, use that instead of ``_tags``.

0 commit comments

Comments
 (0)