From 81b33f1f6fa436e1260579112787ac76f3dbf1db Mon Sep 17 00:00:00 2001 From: Fredrick Brennan Date: Thu, 4 Aug 2022 11:12:04 -0400 Subject: [PATCH] Document how to build docs --- docs/build.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/build.rst b/docs/build.rst index d9b8c60f6..ea8d8be81 100644 --- a/docs/build.rst +++ b/docs/build.rst @@ -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 Homebrew or MacPorts as well. + + +Building docs +-------------- + +|kitty|'s documentation is built via `Sphinx `_. + +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