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

Document how to build docs

Browse Source
This commit is contained in:
Fredrick Brennan 2022-08-04 11:12:04 -04:00 committed by GitHub
parent a1c4ffec20
commit 81b33f1f6f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/build.rst
View File

@ -189,3 +189,24 @@ into which they ssh, without needing to install all of |kitty|.
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/>`_.
On Ubuntu Linux 22.04, these system packages need to be installed:
* ``python3-sphinx``
* ``python3-sphinxext-opengraph``
* ``python3-sphinx-copybutton``
As well as these PyPI (``pip``) packages (e.g. via ``pip install --user``):
* ``sphinx_inline_tabs``
* ``furo`` (a Sphinx theme)
The command is then::
make docs