Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include command line options in the man page #312

Open
lucc opened this issue Jun 28, 2022 · 1 comment
Open

Include command line options in the man page #312

lucc opened this issue Jun 28, 2022 · 1 comment

Comments

@lucc
Copy link
Owner

lucc commented Jun 28, 2022

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 #285 (comment):

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
Copy link

pacien commented Sep 30, 2023

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

lucc added a commit that referenced this issue Oct 1, 2023
Flake lock file updates:

• Updated input 'nixpkgs':
    'github:NixOS/nixpkgs/126f49a01de5b7e35a43fd43f891ecf6d3a51459' (2023-03-15)
  → 'github:NixOS/nixpkgs/c182df2e68bd97deb32c7e4765adfbbbcaf75b60' (2023-09-29)

This also adds the man page to the nix package.  Reported as part of
issue #312.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants