-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
autodoc_default_options should accept True values #5459
Labels
Milestone
Comments
tk0miya
added
extensions:autodoc
type:proposal
a feature suggestion
internals:config
labels
Sep 20, 2018
tk0miya
added a commit
that referenced
this issue
Feb 11, 2019
…cepts_True Closes #5459: autodoc: autodoc_default_options accepts True as a value
Fixed by #6053. |
6 tasks
When it will be in a release? |
It was already released as v2.0.0 in last April. |
jcohenadad
added a commit
to ivadomed/ivadomed
that referenced
this issue
May 31, 2020
To overcome this issue: sphinx-doc/sphinx#5459
hearot
added a commit
to hearot/pyrubrum
that referenced
this issue
Jun 19, 2020
pld-gitsync
pushed a commit
to pld-linux/python-urwid
that referenced
this issue
Jan 16, 2021
...in order to support syntax {"members": True} sphinx-doc/sphinx#5459
dirkmunro89
added a commit
to artofscience/SAOR
that referenced
this issue
Jun 26, 2022
…ult_options. Seems to be a known issue, but should have been fixed sphinx-doc/sphinx#5459. Also added autodoc_mock_imports = [numba] to avoid numba not found warning when compiling. Not sure why this dependency issue, I guess, is there in the first place...
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Short version: Instead of this:
it would make more sense to be able to write this:
The new
autodoc_default_options
config option currently requires that itsdict
values be either strings orNone
, whereNone
"means 'yes/true/on'". Seeing asNone
meansTrue
, it would make more sense to be able to actually writeTrue
instead (but keepNone
around for backwards compatibility).Currently (in Sphinx 1.8), setting an
autodoc_default_options
value toTrue
just produces an unhelpful error message:The text was updated successfully, but these errors were encountered: