diff options
| author | Thomas Heijligen <thomas.heijligen@secunet.com> | 2023-01-31 00:08:42 +0100 |
|---|---|---|
| committer | Thomas Heijligen <src@posteo.de> | 2023-03-01 09:40:52 +0000 |
| commit | f4f2f3dd19784efa26fd5619b7a44b4cdf14b04c (patch) | |
| tree | c9306c071ccd0fbbbdb7a3f37ea5dfcabf8014cb /doc/index.rst | |
| parent | fc533e25623af76d0e6ff87681a7c3122df1607e (diff) | |
| download | flashrom-f4f2f3dd19784efa26fd5619b7a44b4cdf14b04c.tar.gz flashrom-f4f2f3dd19784efa26fd5619b7a44b4cdf14b04c.tar.bz2 flashrom-f4f2f3dd19784efa26fd5619b7a44b4cdf14b04c.zip | |
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 `<meson_mandir>/man8/flashrom.8` and
The html documentation in <meson_datadir>/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 <thomas.heijligen@secunet.com>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/72619
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
Reviewed-by: Alexander Goncharov <chat@joursoir.net>
Diffstat (limited to 'doc/index.rst')
| -rw-r--r-- | doc/index.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 000000000..d309a039e --- /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 |