python-dyndnsc
python-dyndnsc copied to clipboard
infothrill
man page
"make man" uses sphinx to create a man page. but it is the complete docs (like what we have in html).
is this intended or should it be something shorter?
We should definitely use sphinx, but I'm unsure as to how to structure it nicely. Keeping it short is certainly better than keeping it non-existent.
what i meant is that you already HAVE a man page, so it exists, but is a bit long.
ah, yes! Maybe build man page using a different sphinx initialization which would allow to specify a smaller subset of the doc? I don't know sphinx well enough...
it's just a rst file, see an example there: https://bitbucket.org/thomaswaldmann/moin-2.0/src/f6ee7dd9f400befc5a70af07fdfb688f07df45c4/docs/man/?at=default https://bitbucket.org/thomaswaldmann/moin-2.0/src/f6ee7dd9f400befc5a70af07fdfb688f07df45c4/docs/conf.py?at=default#cl-223
@ThomasWaldmann I am not sure what else to add at this point. The skeleton man page is in place now. Do you agree?
I didn't look at dyndnsc stuff recently, but for borgbackup we have some code in setup.py that makes a set of usable length man pages (~ per subcommand).
https://github.com/borgbackup/borg/blob/1.1.3/setup.py#L451