Skip to content

Commit

Permalink
Merge pull request #94 from JWCook/autobuild
Browse files Browse the repository at this point in the history
Add note to docs about usage with sphinx-autobuild
  • Loading branch information
JWCook authored Feb 1, 2024
2 parents 67ac825 + 6f3024f commit b8918e3
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,18 @@ Tags can be passed in either as arguments or in the body of the directive:
tag1, tag2, tag3,
tag4, tag5, tag6,
Usage with sphinx-autobuild
---------------------------

`Sphinx-autobuild <https://github.com/sphinx-doc/sphinx-autobuild>`_ is a live-reload
tool for local development that automatically rebuilds your docs when changes are
detected. Sphinx-tags dynamically generates a tag overview and tag index pages
during each build, so you will want to tell sphinx-autobuild to ignore these
files so it doesn't get stuck in a loop. Example:

.. code-block:: sh
sphinx-autobuild docs docs/_build/html --ignore '**/_tags/*'
If you have set ``tags_output_dir`` to a different path, use that instead of ``_tags``.

0 comments on commit b8918e3

Please sign in to comment.