docs: add info about the docs in the docs

club-1 · Jul 25, 2024 · 42a00d6 · 42a00d6
1 parent ff1a8da
commit 42a00d6
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git 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
@@ -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
@@ -6,3 +6,24 @@ The code hosting and the issue tracker is provided by `GitHub <https://github.co
 .. include:: ../README.rst
    :start-after: .. Development
    :end-before: .. Epilog
+
+Compiling the documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The documentation is obviously generated using `Sphinx <https://sphinx-doc.org>`_,
+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