docs: mention additional python modules needed for building
Also check that they are available in meson.build. Closes #11772
This commit is contained in:
parent
53f43605ce
commit
10d6d2860c
|
@ -8,6 +8,10 @@ Minimum required version of hotdoc is *0.8.9*.
|
||||||
|
|
||||||
Instructions on how to install hotdoc are [here](https://hotdoc.github.io/installing.html).
|
Instructions on how to install hotdoc are [here](https://hotdoc.github.io/installing.html).
|
||||||
|
|
||||||
|
Our custom hotdoc extensions require:
|
||||||
|
- [chevron](https://pypi.org/project/chevron)
|
||||||
|
- [strictyaml](https://pypi.org/project/strictyaml)
|
||||||
|
|
||||||
## Building the documentation
|
## Building the documentation
|
||||||
|
|
||||||
From the Meson repository root dir:
|
From the Meson repository root dir:
|
||||||
|
|
|
@ -1,5 +1,11 @@
|
||||||
project('Meson documentation', version: '1.0')
|
project('Meson documentation', version: '1.0')
|
||||||
|
|
||||||
|
yaml_modname = get_option('unsafe_yaml') ? 'yaml' : 'strictyaml'
|
||||||
|
py = import('python').find_installation('python3', modules: [yaml_modname], required: false)
|
||||||
|
if not py.found()
|
||||||
|
error(f'Cannot build documentation without yaml support')
|
||||||
|
endif
|
||||||
|
|
||||||
cur_bdir = meson.current_build_dir()
|
cur_bdir = meson.current_build_dir()
|
||||||
|
|
||||||
sitemap = files('sitemap.txt')
|
sitemap = files('sitemap.txt')
|
||||||
|
@ -105,6 +111,10 @@ genrelnotes = custom_target(
|
||||||
sitemap = genrelnotes[0]
|
sitemap = genrelnotes[0]
|
||||||
|
|
||||||
hotdoc_prog = find_program('hotdoc', version: '>=0.13.7')
|
hotdoc_prog = find_program('hotdoc', version: '>=0.13.7')
|
||||||
|
py = import('python').find_installation('python3', modules: ['chevron'], required: false)
|
||||||
|
if not py.found()
|
||||||
|
error('Building the HTML docs requires the chevron module to render generated markdown pages')
|
||||||
|
endif
|
||||||
|
|
||||||
hotdoc = import('hotdoc')
|
hotdoc = import('hotdoc')
|
||||||
documentation = hotdoc.generate_doc(meson.project_name(),
|
documentation = hotdoc.generate_doc(meson.project_name(),
|
||||||
|
|
Loading…
Reference in New Issue