IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-11-03 12:48:34 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6365 from tk0miya/refactor_py_domain

Browse Source 
Add :abstractmethod: option to py:method directive and support abstractmethod by autodoc
This commit is contained in:
Takeshi KOMIYA authored and GitHub committed 2019-05-19 23:46:34 +09:00
2 parents 603bae4173 e288999933
commit 557d8d140e
8 files changed
+118 -9
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

doc/usage/restructuredtext/domains.rst
+5 -4
View File
@@ -226,16 +226,17 @@ The following directives are provided for module and class contents:
The ``async`` option can be given (with no value) to indicate the method is
an async method.
The ``classmethod`` option and ``staticmethod`` option can be given (with
no value) to indicate the method is a class method (or a static method).
The ``abstractmethod``, ``classmethod`` option and ``staticmethod`` option
can be given (with no value) to indicate the method is an abstract method,
a class method or a static method.
The ``property`` option can be given (with no value) to indicate the method
is a property.
.. versionchanged:: 2.1
``:async:``, ``:classmethod:``, ``:property:`` and ``:staticmethod:``
options added.
``:abstractmethod:``, ``:async:``, ``:classmethod:``, ``:property:`` and
``:staticmethod:`` options added.
.. rst:directive:: .. py:staticmethod:: name(parameters)