Hi,
this patch series wires up missing HTML-based documentation with Meson.
This includes a couple of missing manpages, the user manual as well as
the random set of articles that we have. It also starts to generate the
indices for API docs and howtos so that the result is a complete set of
HTML docs, same as with our Makefile. It also fixes a couple of smaller
issues I found while working on the series.
Notably missing yet is an integration with CI as well as sanity checks
for any kind of missing docs in Meson. I'll work on this in a separate
patch series once the initial CI integration as well as this patch
series here have landed.
Further missing is the generation of both info pages and a user manual
PDF. I couldn't find any users of these anywhere in downstream distros,
so I decided to not care for now until somebody complains.
The series is built on top of caacdb5dfd (The fifteenth batch,
2024-12-10) with ps/build at 904339edbd (Introduce support for the Meson
build system, 2024-12-06) merged into it.
Thanks!
Patrick
---
Patrick Steinhardt (10):
meson: wire up support for AsciiDoctor
meson: properly wire up dependencies for our docs
meson: fix generation of merge tools
meson: generate HTML pages for all man page categories
Documentation: inline user-manual.conf
meson: generate user manual
Documentation: refactor "api-index.sh" for out-of-tree builds
Documentation: refactor "howto-index.sh" for out-of-tree builds
meson: generate articles
meson: install static files for HTML documentation
Documentation/Makefile | 8 +-
Documentation/asciidoc.conf.in | 10 ++
Documentation/{ => howto}/howto-index.sh | 2 +-
Documentation/howto/meson.build | 62 +++++++++
Documentation/meson.build | 221 +++++++++++++++++++++++++------
Documentation/technical/api-index.sh | 19 ++-
Documentation/technical/meson.build | 66 +++++++++
Documentation/user-manual.conf | 11 --
meson_options.txt | 2 +
9 files changed, 344 insertions(+), 57 deletions(-)
---
base-commit: 0b8924716a9b7975cb21e464917bb475de842a27
change-id: 20241212-b4-pks-meson-docs-2634bf3e7764
