Fix #759: autodoc: Add sphinx.ext.autodoc.preserve_defaults extension #8771
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tk0miya
added
type:enhancement
tk0miya
commented
Jan 27, 2021
tk0miya
force-pushed
the
759_preserve_defaults
branch
from
a6e9251
to
f2ec653
Compare
tk0miya
force-pushed
the
759_preserve_defaults
branch
from
f2ec653
to
8bf96bc
Compare
tk0miya
force-pushed
the
759_preserve_defaults
branch
from
8bf96bc
to
71d6b34
Compare
tk0miya
force-pushed
the
759_preserve_defaults
branch
from
71d6b34
to
add2f9e
Compare
… extension Add a new extension `sphinx.ext.autodoc.preserve_defaults`. It preserves the default argument values of function signatures in source code and keep them not evaluated for readability. This is an experimental extension and it will be integrated into autodoc core in Sphinx-4.0.
tk0miya
force-pushed
the
759_preserve_defaults
branch
from
add2f9e
to
1ea11b1
Compare
This was referenced Mar 6, 2021
peterjc
added a commit
to peterjc/biopython
that referenced
this pull request
Mar 6, 2021
peterjc
added a commit
to peterjc/biopython
that referenced
this pull request
Mar 6, 2021
See sphinx-doc/sphinx#8771 autodoc_preserve_defaults was new in Sphinx 3.5
3 tasks
peterjc
added a commit
to biopython/biopython
that referenced
this pull request
May 4, 2021
See sphinx-doc/sphinx#8771 autodoc_preserve_defaults was new in Sphinx 3.5
JoaoRodrigues
pushed a commit
to JoaoRodrigues/biopython
that referenced
this pull request
Jun 3, 2021
See sphinx-doc/sphinx#8771 autodoc_preserve_defaults was new in Sphinx 3.5
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Purpose
sphinx.ext.autodoc.preserve_defaults.and keep them not evaluated for readability. This is an experimental
extension and it will be integrated into autodoc core in Sphinx-4.0.