Commit graph

2 commits

Author SHA1 Message Date
David Rheinsberg
108aa87232 docs/osbuild.1: extend EXAMPLES section
This extends the EXAMPLES section with more examples, reduces their
complexity, and also restructures the layout to make it nicer to read
in the resulting TROFF file.
2020-03-07 13:43:24 +01:00
David Rheinsberg
71e71a0c77 docs: add man-page osbuild(1)
This adds a man-page `osbuild(1)` which documents the `osbuild`
executable. We use the python-native doc-utils and rely on
reStructuredText as documentation language.

While it is common with python libraries to use sphinx for documenting
the project, this commit explicitly does not import a full sphinx
documentation. Instead, it only adds the `rst` sources for man-pages.
These can be built by distributions via a simple:

    rst2man docs/<manpage>.rst docs/<output-file>
2020-03-02 21:34:09 +01:00