From 42a00d69d9460c3c4251b912b0c69e6b6c513468 Mon Sep 17 00:00:00 2001 From: Nicolas Peugnet Date: Thu, 25 Jul 2024 13:52:15 +0200 Subject: [PATCH] docs: add info about the docs in the docs --- CHANGELOG.md | 4 ++++ README.rst | 4 +--- docs/development.rst | 21 +++++++++++++++++++++ 3 files changed, 26 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8a455a3..aa5203b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## [unreleased] +### Added + +- Add information about the documentation in the documentation. + ## [v1.3.0] - 2024-07-22 ### Fixed diff --git a/README.rst b/README.rst index 375b43d..a8f94d6 100644 --- a/README.rst +++ b/README.rst @@ -69,9 +69,7 @@ Development requirements - **composer**: to install PHP development dependencies - **pigz**: (Optional) to build tests data, will fallback to a PHP script if not present -On Debian and derivatives: - -.. code:: shell +On Debian and derivatives:: sudo apt install make composer pigz diff --git a/docs/development.rst b/docs/development.rst index 67607db..81137bd 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -6,3 +6,24 @@ The code hosting and the issue tracker is provided by `GitHub `_, +so the requierements are: + +- **sphinx**: the documentation generator +- **sphinxcontrib-phpdomain**: to allow documenting PHP code +- **myst-parser**: to include the Markdown formatted changelog + +On Debian and derivatives:: + + sudo apt install sphinx-doc python3-sphinxcontrib.phpdomain python3-myst-parser + +Then to build the documentation (see :ref:`builders` for available builders): + +.. code:: sh + + make docs # Using the default builder (html) + make docs BUILDER=epub # Using a specific builder