freshlybakedca.ke
Git fork
Merge branch 'ps/meson-build-docs'
The build procedure based on meson learned a target to only build
documentation, similar to "make doc".
* ps/meson-build-docs:
ci: don't compile whole project when testing docs with Meson
meson: print docs backend as part of the summary
meson: introduce a "docs" alias to compile documentation only
+2
-2
Documentation/howto/meson.build
+2
-2
Documentation/howto/meson.build
···
29
29
output: 'howto-index.adoc',
30
30
)
31
31
32
-
custom_target(
32
+
doc_targets += custom_target(
33
33
command: asciidoc_html_options,
34
34
input: howto_index,
35
35
output: 'howto-index.html',
···
51
51
capture: true,
52
52
)
53
53
54
-
custom_target(
54
+
doc_targets += custom_target(
55
55
command: asciidoc_html_options,
56
56
input: howto_stripped,
57
57
output: fs.stem(howto_stripped.full_path()) + '.html',
+4
-4
Documentation/meson.build
+4
-4
Documentation/meson.build
···
377
377
output: fs.stem(manpage) + '.xml',
378
378
)
379
379
380
-
custom_target(
380
+
doc_targets += custom_target(
381
381
command: [
382
382
xmlto,
383
383
'-m', '@INPUT0@',
···
400
400
endif
401
401
402
402
if get_option('docs').contains('html')
403
-
custom_target(
403
+
doc_targets += custom_target(
404
404
command: asciidoc_common_options + [
405
405
'--backend=' + asciidoc_html,
406
406
'--doctype=manpage',
···
452
452
depends: documentation_deps,
453
453
)
454
454
455
-
custom_target(
455
+
doc_targets += custom_target(
456
456
command: [
457
457
xsltproc,
458
458
'--xinclude',
···
481
481
]
482
482
483
483
foreach article : articles
484
-
custom_target(
484
+
doc_targets += custom_target(
485
485
command: asciidoc_common_options + [
486
486
'--backend=' + asciidoc_html,
487
487
'--out-file=@OUTPUT@',
+2
-2
Documentation/technical/meson.build
+2
-2
Documentation/technical/meson.build
···
46
46
output: 'api-index.adoc',
47
47
)
48
48
49
-
custom_target(
49
+
doc_targets += custom_target(
50
50
command: asciidoc_html_options,
51
51
input: api_index,
52
52
output: 'api-index.html',
···
56
56
)
57
57
58
58
foreach article : api_docs + articles
59
-
custom_target(
59
+
doc_targets += custom_target(
60
60
command: asciidoc_html_options,
61
61
input: article,
62
62
output: fs.stem(article) + '.html',
+2
-2
ci/test-documentation.sh
+2
-2
ci/test-documentation.sh
···
48
48
49
49
# Build docs with Meson and AsciiDoc
50
50
meson setup build-asciidoc -Ddocs=html,man -Ddocs_backend=asciidoc
51
-
meson compile -C build-asciidoc
51
+
meson compile -C build-asciidoc docs
52
52
check_docs build-asciidoc AsciiDoc
53
53
rm -rf build-asciidoc
54
54
55
55
# Build docs with Meson and AsciiDoctor
56
56
meson setup build-asciidoctor -Ddocs=html,man -Ddocs_backend=asciidoctor
57
-
meson compile -C build-asciidoctor
57
+
meson compile -C build-asciidoctor docs
58
58
check_docs build-asciidoctor Asciidoctor
59
59
rm -rf build-asciidoctor
60
60
+2
-2
contrib/contacts/meson.build
+2
-2
contrib/contacts/meson.build
···
20
20
output: 'git-contacts.xml',
21
21
)
22
22
23
-
custom_target(
23
+
doc_targets += custom_target(
24
24
command: [
25
25
xmlto,
26
26
'-m', '@INPUT@',
···
39
39
endif
40
40
41
41
if get_option('docs').contains('html')
42
-
custom_target(
42
+
doc_targets += custom_target(
43
43
command: asciidoc_common_options + [
44
44
'--backend=' + asciidoc_html,
45
45
'--doctype=manpage',
+2
-2
contrib/subtree/meson.build
+2
-2
contrib/subtree/meson.build
···
38
38
output: 'git-subtree.xml',
39
39
)
40
40
41
-
custom_target(
41
+
doc_targets += custom_target(
42
42
command: [
43
43
xmlto,
44
44
'-m', '@INPUT@',
···
57
57
endif
58
58
59
59
if get_option('docs').contains('html')
60
-
custom_target(
60
+
doc_targets += custom_target(
61
61
command: asciidoc_common_options + [
62
62
'--backend=' + asciidoc_html,
63
63
'--doctype=manpage',
+10
meson.build
+10
meson.build
···
2101
2101
2102
2102
subdir('bin-wrappers')
2103
2103
if get_option('docs') != []
2104
+
doc_targets = []
2104
2105
subdir('Documentation')
2106
+
else
2107
+
docs_backend = 'none'
2105
2108
endif
2106
2109
2107
2110
subdir('contrib')
2111
+
2112
+
# Note that the target is intentionally configured after including the
2113
+
# 'contrib' directory, as some tool there also have their own manpages.
2114
+
if get_option('docs') != []
2115
+
alias_target('docs', doc_targets)
2116
+
endif
2108
2117
2109
2118
exclude_from_check_headers = [
2110
2119
'compat/',
···
2244
2253
2245
2254
summary({
2246
2255
'csprng': csprng_backend,
2256
+
'docs': docs_backend,
2247
2257
'https': https_backend,
2248
2258
'sha1': sha1_backend,
2249
2259
'sha1_unsafe': sha1_unsafe_backend,