diff options
| author | Eli Schwartz <eschwartz@archlinux.org> | 2023-05-09 21:10:55 -0400 |
|---|---|---|
| committer | Eli Schwartz <eschwartz@archlinux.org> | 2023-05-09 21:33:33 -0400 |
| commit | 10d6d2860c6abc29000d94f019af35cf931c315d (patch) | |
| tree | 015c7dd37e3bce252df8acdca77431fc86f1a310 | |
| parent | 53f43605ce05efa9c5c3b4403be6bbd23ebdb88c (diff) | |
| download | meson-10d6d2860c6abc29000d94f019af35cf931c315d.tar.gz | |
docs: mention additional python modules needed for building
Also check that they are available in meson.build.
Closes #11772
| -rw-r--r-- | docs/README.md | 4 | ||||
| -rw-r--r-- | docs/meson.build | 10 |
2 files changed, 14 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md index f6645d34e..169e9cc4a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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). +Our custom hotdoc extensions require: +- [chevron](https://pypi.org/project/chevron) +- [strictyaml](https://pypi.org/project/strictyaml) + ## Building the documentation From the Meson repository root dir: diff --git a/docs/meson.build b/docs/meson.build index f651feb2a..3ad12b7fd 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -1,5 +1,11 @@ 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() sitemap = files('sitemap.txt') @@ -105,6 +111,10 @@ genrelnotes = custom_target( sitemap = genrelnotes[0] 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') documentation = hotdoc.generate_doc(meson.project_name(), |