From f4f2f3dd19784efa26fd5619b7a44b4cdf14b04c Mon Sep 17 00:00:00 2001 From: Thomas Heijligen Date: Tue, 31 Jan 2023 00:08:42 +0100 Subject: move manpage to sphinx Use sphinx (sphinx-doc.org) to generate the UNIX man page from an reStructuredText file instead of dealing with plain groff. Use `meson setup -Dman-pages=enabled` to build the man page, and `meson setup -Ddocumentation=enabled` to build the web documentation explicitly. Both are enabled automatically if sphinx-build is found. The man page will be installed as `/man8/flashrom.8` and The html documentation in /doc/flashrom/html`. The Makefile builds only the man-page format. Increase the minimum version of meson from 0.53.0 to 0.57.0 to be able to pass environment variables to the custom_target() command. That is needed to pass the FLASHROM_VERSION to the documentation. Change-Id: Iee9f1164c5913e47385e6f7d51dc7775a58b5a67 Signed-off-by: Thomas Heijligen Reviewed-on: https://review.coreboot.org/c/flashrom/+/72619 Tested-by: build bot (Jenkins) Reviewed-by: Anastasia Klimchuk Reviewed-by: Alexander Goncharov --- doc/index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 doc/index.rst (limited to 'doc/index.rst') diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 00000000..d309a039 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,11 @@ +.. flashrom documentation master file, created by + sphinx-quickstart on Mon Jan 30 17:34:19 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. toctree:: + :hidden: + + classic_cli_manpage + +.. include:: ../README -- cgit v1.2.3