From 329043ba0859cf426449a80e73eb2a5376e4282c Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sat, 20 Aug 2022 12:09:36 +0530 Subject: [PATCH] Cleanup build documentation Note how to build the kitty docs wherever needed instead of in a separate section --- docs/build.rst | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/docs/build.rst b/docs/build.rst index 420075637..3c741ebd9 100644 --- a/docs/build.rst +++ b/docs/build.rst @@ -87,14 +87,21 @@ You can run |kitty|, as:: If that works, you can create a symlink to the launcher in :file:`~/bin` or some other directory on your PATH so that you can run |kitty| using just ``kitty``. +To have the kitty documentation available locally, run:: + + python3 -m pip install -r docs/requirements.txt && make docs + Building kitty.app on macOS from source ------------------------------------------- Run:: + python3 -m pip install -r docs/requirements.txt && make docs make app +Building the docs needs to be done only once. + This :file:`kitty.app` unlike the released one does not include its own copy of Python and the other dependencies. So if you ever un-install/upgrade those dependencies you might have to rebuild the app. @@ -196,17 +203,3 @@ the kitty program expects to find them there. This applies to creating packages for |kitty| for macOS package managers such as Homebrew or MacPorts as well. - - -Building docs --------------- - -|kitty|'s documentation is built via `Sphinx `_. - -To install the dependencies needed for the documentation, run:: - - python -m pip docs/requirements.txt - -To build the docs, use:: - - make docs