#2232 Generate man pages from docs
Opened by tkopecek. Modified

sphinx is able to produce also manpages. Maybe we should structure docs a bit, so some basic manpages can be produced.


I'm fairly familiar with this process if help is needed. I author in markdown and produce roff/html from there.

Edit: Just realized, I do my man pages (as above) with pandoc. I do use sphinx but for autdoc of Python, however.

Metadata Update from @tkopecek:
- Custom field Size adjusted to None
- Issue tagged with: doc

It would be nice to unify the "--help" output and the man page output so everything stays up-to-date.

Another option I was thinking about is that some CLIs will display the help text through a pager, like:

aws configure help

or

systemctl --help

I wonder if we could just expand the "--help" text more for each sub-command, and then generate man pages from that?

This issue has been migrated to Fedora Forge:
https://forge.fedoraproject.org/koji/koji/issues/2232

Please continue any further discussion there.

Metadata