refactor: Deprecate no_docstring argument for Documenter.add_content()#8533
Merged
tk0miya merged 1 commit intosphinx-doc:3.xfrom Dec 13, 2020
Merged
refactor: Deprecate no_docstring argument for Documenter.add_content()#8533tk0miya merged 1 commit intosphinx-doc:3.xfrom
no_docstring argument for Documenter.add_content()#8533tk0miya merged 1 commit intosphinx-doc:3.xfrom
Conversation
This deprecates `no_docstring` argument for Documenter.add_content(). After this change, please use Documenter.get_doc() to control (suppress) the content of the python object.
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this pull request
Dec 23, 2020
…s classes On the refactoring of Documenter.add_content() method, the autodoc-process-docstring event is emitted to the alias classes (called as doc_as_attr in our code) unexpectedly. Before the change, it has never been emitted. The event causes that extensions (ex. numpydoc) confused. So this reverts the change temporarily (during 3.4.x). refs: sphinx-doc#8533
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this pull request
Dec 26, 2020
Deprecate `no_docstring` argument for `Documenter.add_content()` again. At the first trial (sphinx-doc#8533), it changes the behavior of `autodoc-process-docstring` event; it is emitted unexpectedly for an alias of class. But it brings an incompatible change to extensions. Hence it was partially reverted at sphinx-doc#8581. This keeps not calling the event for an alias of class. To do that, now `Documenter.get_doc()` can return None value.
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this pull request
Dec 26, 2020
Deprecate `no_docstring` argument for `Documenter.add_content()` again. At the first trial (sphinx-doc#8533), it changes the behavior of `autodoc-process-docstring` event; it is emitted unexpectedly for an alias of class. But it brings an incompatible change to extensions. Hence it was partially reverted at sphinx-doc#8581. This keeps not calling the event for an alias of class. To do that, now `Documenter.get_doc()` can return None value.
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this pull request
Dec 26, 2020
Deprecate `no_docstring` argument for `Documenter.add_content()` again. At the first trial (sphinx-doc#8533), it changes the behavior of `autodoc-process-docstring` event; it is emitted unexpectedly for an alias of class. But it brings an incompatible change to extensions. Hence it was partially reverted at sphinx-doc#8581. This keeps not calling the event for an alias of class. To do that, now `Documenter.get_doc()` can return None value.
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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
no_docstringargument for Documenter.add_content().After this change, please use Documenter.get_doc() to control (suppress)
the content of the python object.