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

Autogenerate configuration reference #999

Open
LecrisUT opened this issue Feb 21, 2025 · 0 comments
Open

Autogenerate configuration reference #999

LecrisUT opened this issue Feb 21, 2025 · 0 comments

Comments

@LecrisUT
Copy link
Collaborator

Although all settings are mapped to the python object, just to avoid possible confusion it would be nice to generate the original configuration options 1 as well, something like

```{confval} {{ field-name }}
:type: {{ type }}
:default: {{ default }}
{{ docstring }}

Python equivalent: {{ python-name }}
```

It would help a bit with cross-referencing the options and it would work nice with tippy.

Footnotes

  1. https://www.sphinx-doc.org/en/master/usage/domains/standard.html#directive-confval

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