KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Cleanup build documentation

Browse Source 
Note how to build the kitty docs wherever needed instead of in a
separate section
This commit is contained in:
Kovid Goyal 2022-08-20 12:09:36 +05:30
parent e289f4959f
commit 329043ba08
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 7 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/build.rst
View File

@ -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 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``. 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 Building kitty.app on macOS from source
------------------------------------------- -------------------------------------------
Run:: Run::
python3 -m pip install -r docs/requirements.txt && make docs
make app 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 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 Python and the other dependencies. So if you ever un-install/upgrade those
dependencies you might have to rebuild the app. 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 This applies to creating packages for |kitty| for macOS package managers such as
Homebrew or MacPorts as well. Homebrew or MacPorts as well.
Building docs
--------------
|kitty|'s documentation is built via `Sphinx <https://www.sphinx-doc.org/en/master/>`_.
To install the dependencies needed for the documentation, run::
python -m pip docs/requirements.txt
To build the docs, use::
make docs