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

Clean up build docs a bit

Browse Source
This commit is contained in:
Kovid Goyal 2022-08-20 08:13:42 +05:30
parent da618584af
commit 6aa3405c78
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 8 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/build.rst
View File

@ -180,8 +180,11 @@ You should probably split |kitty| into three packages:
:code:`kitty` :code:`kitty`
Installs the main program Installs the main program
This allows users to install the terminfo and shell integration files on servers This allows users to install the terminfo and shell integration files on
into which they ssh, without needing to install all of |kitty|. servers into which they ssh, without needing to install all of |kitty|. The
shell integration files **must** still be present in
:file:`lib/kitty/shell-integration` when installing the kitty main package as
the kitty program expects to find them there.
.. note:: .. note::
You need a couple of extra dependencies to build linux-package. :file:`tic` You need a couple of extra dependencies to build linux-package. :file:`tic`
@ -200,17 +203,10 @@ Building docs
|kitty|'s documentation is built via `Sphinx <https://www.sphinx-doc.org/en/master/>`_. |kitty|'s documentation is built via `Sphinx <https://www.sphinx-doc.org/en/master/>`_.
On Ubuntu Linux 22.04, these system packages need to be installed: To install the dependencies needed for the documentation, run::
* ``python3-sphinx`` python -m pip docs/requirements.txt
* ``python3-sphinxext-opengraph``
* ``python3-sphinx-copybutton``
As well as these PyPI (``pip``) packages (e.g. via ``pip install --user``): To build the docs, use::
* ``sphinx_inline_tabs``
* ``furo`` (a Sphinx theme)
The command is then::
make docs make docs