IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6979 from tk0miya/6830_autodoc_private

Browse Source 
Close #6830: autodoc: consider a member private if docstring contains :private:
This commit is contained in:
Takeshi KOMIYA
2020-01-11 15:14:52 +09:00
committed by GitHub
parent 91e44da836 b968bb91e9
commit f169560395
11 changed files with 176 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/usage/restructuredtext/domains.rst
View File

@@ -354,6 +354,9 @@ Info field lists
~~~~~~~~~~~~~~~~
.. versionadded:: 0.4
.. versionchanged:: 3.0
meta fields are added.
Inside Python object description directives, reST field lists with these fields
are recognized and formatted nicely:
@@ -367,6 +370,10 @@ are recognized and formatted nicely:
* ``vartype``: Type of a variable. Creates a link if possible.
* ``returns``, ``return``: Description of the return value.
* ``rtype``: Return type. Creates a link if possible.
* ``meta``: Add metadata to description of the python object. The metadata will
not be shown on output document. For example, ``:meta private:`` indicates
the python object is private member. It is used in
:py:mod:`sphinx.ext.autodoc` for filtering members.
.. note::