refactor: Deprecate no_docstring argument for Documenter.add_content()

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.
This commit is contained in:
Takeshi KOMIYA
2020-12-13 02:11:14 +09:00
parent 8823d1c528
commit 3638a9e4d1
3 changed files with 28 additions and 14 deletions

View File

@@ -31,6 +31,12 @@ The following is a list of deprecated interfaces.
- 5.0
- N/A
* - The ``no_docstring`` argument of
``sphinx.ext.autodoc.Documenter.add_content()``
- 3.4
- 5.0
- ``sphinx.ext.autodoc.Documenter.get_doc()``
* - ``sphinx.ext.autodoc.Documenter.get_object_members()``
- 3.4
- 6.0