lucc / khard

Console vcard client
https://khard.readthedocs.io/en/latest/
GNU General Public License v3.0
594 stars 66 forks source link

Include command line options in the man page #312

Open lucc opened 2 years ago

lucc commented 2 years ago

The man page does not list all command line options because I was to lazy to type them all again. There are solutions that can import argparse objects into sphinx documents.

Extracted from https://github.com/lucc/khard/issues/285#issuecomment-782580258:

I found my branch and it uses https://github.com/alex-rudakov/sphinx-argparse to include the argparse stuff into the sphinx document, so that one does not have to type all the options and docs again. (There a quite a lot options in khard :)

I just played around with the branch again and noticed the following (i pushed the branch to github, so you can have a look: feature/auto-man):

I am not really sure if I want to use that,, I will wait for an upstream decision first. If you know of any other alternatives, I am happy to hear them.

pacien commented 11 months ago

By the way, the manual page doesn't seem to be installed with the NixOS package.