Debian Codegraph @

subprojects/meson-docs/docs/README.md

raw
1 # Meson Documentation
2
3 ## Build dependencies
4
5 Meson uses itself and [hotdoc](https://github.com/hotdoc/hotdoc) for generating documentation.
6
7 Minimum required version of hotdoc is *0.8.9*.
8
9 Instructions on how to install hotdoc are [here](https://hotdoc.github.io/installing.html).
10
11 Our custom hotdoc extensions require:
12 - [chevron](https://pypi.org/project/chevron)
13 - [strictyaml](https://pypi.org/project/strictyaml)
14
15 ## Building the documentation
16
17 From the Meson repository root dir:
18 ```
19 $ cd docs/
20 $ meson setup built_docs/
21 $ ninja -C built_docs/
22 ```
23 Now you should be able to open the documentation locally
24 ```
25 built_docs/Meson documentation-doc/html/index.html
26 ```
27
28 ## Upload
29
30 Meson uses the git-upload hotdoc plugin which basically
31 removes the html pages and replaces with the new content.
32
33 You can simply run:
34 ```
35 $ ninja -C built_docs/ upload
36 ```