mirror of
https://gitlab.com/qemu-project/meson.git
synced 2025-07-02 19:24:32 +08:00
c18a9715b8
* doc: fix hotdoc misuse for dynamically generated content hotdoc has a native include feature for including files inline. Use this to generate one file for each dynamically generated code block, and include that file in Commands.md; see: https://hotdoc.github.io/syntax-extensions.html#smart-file-inclusion-syntax This permits us to move back to using the in-tree version of the hotdoc *.md sources, thus fixing the incorrect inclusion of "builddir/" in the "Edit on github" links which resulted from using copies as the source. Fixes #8061 * doc: call the dummy file a "stamp" as it is a better known term
38 lines
1.1 KiB
Meson
38 lines
1.1 KiB
Meson
project('Meson documentation', version: '1.0')
|
|
|
|
cur_bdir = meson.current_build_dir()
|
|
|
|
# Only the script knows which files are being generated
|
|
docs_gen = custom_target(
|
|
'gen_docs',
|
|
input: files('markdown/index.md'),
|
|
output: 'gen_docs.stamp',
|
|
command: [
|
|
files('../tools/regenerate_docs.py'),
|
|
'--output-dir', cur_bdir,
|
|
'--dummy-output-file', '@OUTPUT@',
|
|
],
|
|
build_by_default: true,
|
|
install: false)
|
|
|
|
hotdoc = import('hotdoc')
|
|
documentation = hotdoc.generate_doc(meson.project_name(),
|
|
project_version: meson.project_version(),
|
|
sitemap: 'sitemap.txt',
|
|
build_by_default: true,
|
|
depends: docs_gen,
|
|
index: 'markdown/index.md',
|
|
install: false,
|
|
extra_assets: ['images/'],
|
|
include_paths: ['markdown', cur_bdir],
|
|
default_license: 'CC-BY-SAv4.0',
|
|
html_extra_theme: join_paths('theme', 'extra'),
|
|
git_upload_repository: 'git@github.com:jpakkane/jpakkane.github.io.git',
|
|
edit_on_github_repository: 'https://github.com/mesonbuild/meson',
|
|
syntax_highlighting_activate: true,
|
|
)
|
|
|
|
run_target('upload',
|
|
command: [find_program('hotdoc'), 'run', '--conf-file', documentation.config_path()]
|
|
)
|