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

Directive sphinx_argparse_cli seems to not be recognized #196

Open
jsilva234 opened this issue Oct 22, 2024 · 0 comments
Open

Directive sphinx_argparse_cli seems to not be recognized #196

jsilva234 opened this issue Oct 22, 2024 · 0 comments

Comments

@jsilva234
Copy link

jsilva234 commented Oct 22, 2024

Hey there

Not being able to use this sphinx extension with the guideline in the README file.

I got the following exception:

Exception occurred:
  File "/Users/joaosilva/.pyenv/versions/cli_sphinx_3.12/lib/python3.12/site-packages/sphinx_argparse_cli/_logic.py", line 110, in parser
    module_name, attr_name = self.options["module"], self.options["func"]
                             ~~~~~~~~~~~~^^^^^^^^^^
KeyError: 'module'

RST code was something like this:

.. sphinx_argparse_cli::
    :module: base_parsers
    :func: build_parser
    :prog: name
    :no_default_values:

After some tweaking, was able to make it run, but had to change this line from sphinx_argparse_cli to sphinx-argparse-cli and using the directive accordingly.
Not sure if this make sense to you, I'm new to sphinx

python 3.12
sphinx 8.1.3
sphinx-argparse-cli 1.18.2

Cheers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant