]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc/README.md: update about requirements and building
authorAleš Mrázek <ales.mrazek@nic.cz>
Wed, 1 Mar 2023 15:16:04 +0000 (16:16 +0100)
committerAleš Mrázek <ales.mrazek@nic.cz>
Mon, 5 Jun 2023 13:34:21 +0000 (15:34 +0200)
doc/README.md

index 7b781413398320a7f4ff3f8b91927f95d0bf146a..eedc60f3a7fb06683d9be4182eff6ce0e6315a4b 100644 (file)
@@ -5,28 +5,35 @@ It does not however contain API documentation, which is built separately in this
 
 ### Requirements
 
+To generate documentation you need to install [meson][meson] and [ninja][ninja].
+
 The code is documented with [Doxygen][doxygen] JavaDoc style, a prettified documentation
-also requires [breathe][breathe], [Sphinx][sphinx] and [Sphinx tabs][sphinx-tabs] for building sane documentation pages.
-It is not however required.
+also requires [breathe][breathe], [Sphinx][sphinx], [Sphinx tabs][sphinx-tabs] and [Sphinx Read the Docs theme][sphinx_rtd_theme] for building sane documentation pages.
 
+[meson]: https://mesonbuild.com/
+[ninja]: https://ninja-build.org/
 [doxygen]:https://www.stack.nl/~dimitri/doxygen/manual/index.html
 [breathe]: https://github.com/michaeljones/breathe
 [sphinx]: http://sphinx-doc.org/
 [sphinx-tabs]: https://sphinx-tabs.readthedocs.io/
+[sphinx_rtd_theme]: https://sphinx-rtd-theme.readthedocs.io/en/stable/
 
-You can get the extra dependencies with pip:
+You can install dependencies with pip:
 
 ```sh
-pip install -U Sphinx sphinx-tabs breathe
+pip install -U Sphinx sphinx-tabs sphinx_rtd_theme breathe
 # Alternatively
-pip -r doc/requirements.txt
+pip install -r doc/requirements.txt
 ```
 
 ### Building documentation
 
-If you satisfy the requirements, it's as easy as `make doc`, which builds the documentation in this folder `doc/html`.
+If you satisfy the requirements, the documentation will be generated to `doc/html` directory.
+You must be in the root directory of the project.
+
+It may be needed to initialize git submodules `git submodule update --init --recursive`.
 
 ```sh
-$ meson build_dir -Ddoc=enabled
+$ meson setup build_dir -Ddoc=enabled
 $ ninja -C build_dir doc
 ```