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

Note the changed docs build requirements

Browse Source
This commit is contained in:
Kovid Goyal 2021-07-19 08:14:26 +05:30
parent fe18a5de92
commit 103744e2ca
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/build.rst
View File

@ -128,18 +128,19 @@ This allows users to install the terminfo file on servers into which they ssh,
without needing to install all of |kitty|. without needing to install all of |kitty|.
.. note:: .. note::
You need a couple of extra dependencies to build linux-package. You need a couple of extra dependencies to build linux-package.
:file:`tic` to compile terminfo files, usually found in the :file:`tic` to compile terminfo files, usually found in the
development package of :file:`ncurses`. Also, if you are building from development package of :file:`ncurses`. Also, if you are building from
a git checkout instead of the released source code tarball, you will a git checkout instead of the released source code tarball, you will
need :file:`sphinx-build` from the `Sphinx documentation generator need to install the dependencies from ``docs/requirements.txt`` to
<https://www.sphinx-doc.org/>`_. build the kitty documentation. They can be installed most easily with
``python -m pip -r docs/requirements.txt``.
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
brew or MacPorts as well. brew or MacPorts as well.
.. note:: .. note::
|kitty| has its own update check mechanism, if you would like to turn |kitty| has its own update check mechanism, if you would like to turn
it off for your package, use it off for your package, use
``python3 setup.py linux-package --update-check-interval=0`` ``python3 setup.py linux-package --update-check-interval=0``