From e0eccf7883c718c2e68980719efcda1f21e57485 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Mon, 29 May 2023 08:20:25 +0530 Subject: [PATCH] Add a note about develop-docs to the build docs Also include sphinx-autobuild as a docs dependency --- docs/build.rst | 4 ++++ docs/requirements.txt | 1 + 2 files changed, 5 insertions(+) diff --git a/docs/build.rst b/docs/build.rst index 66b08689f..bd8a73c77 100644 --- a/docs/build.rst +++ b/docs/build.rst @@ -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 ------------------------------------------- diff --git a/docs/requirements.txt b/docs/requirements.txt index 5a57e5492..e2110e3de 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ furo sphinx-copybutton sphinxext-opengraph sphinx-inline-tabs +sphinx-autobuild