Add a note about develop-docs to the build docs

Also include sphinx-autobuild as a docs dependency
2026-08-15 18:53:34 +00:00 · 2023-05-29 08:21:08 +05:30
parent 7d2ac765a4
commit e0eccf7883
2 changed files with 5 additions and 0 deletions
@@ -88,6 +88,10 @@ To have the kitty documentation available locally, run::

    python3 -m pip install -r docs/requirements.txt && make docs

+To develop the docs, with live reloading, use::
+
+    python3 -m pip install -r docs/requirements.txt && make develop-docs
+

 Building kitty.app on macOS from source
 -------------------------------------------
@@ -3,3 +3,4 @@ furo
 sphinx-copybutton
 sphinxext-opengraph
 sphinx-inline-tabs
+sphinx-autobuild