diff options
author | Berker Peksag <berker.peksag@gmail.com> | 2015-12-08 12:15:19 +0200 |
---|---|---|
committer | Berker Peksag <berker.peksag@gmail.com> | 2015-12-08 12:15:19 +0200 |
commit | 94cd3062b186b2ca59cb9eb620861ebb25cddc57 (patch) | |
tree | 655449e627f16d5b6769ef6209c4dbcd8a24ac28 /Doc/tools/extensions | |
parent | 2dc35f2195a86bc3a99181420a6271951609da5c (diff) | |
parent | ec07d5b16cd9fb314ad6dd40c62cd05a47d40ab1 (diff) | |
download | cpython-94cd3062b186b2ca59cb9eb620861ebb25cddc57.tar.gz |
Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly
Diffstat (limited to 'Doc/tools/extensions')
-rw-r--r-- | Doc/tools/extensions/pyspecific.py | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/Doc/tools/extensions/pyspecific.py b/Doc/tools/extensions/pyspecific.py index 9b78184d67..7986017d01 100644 --- a/Doc/tools/extensions/pyspecific.py +++ b/Doc/tools/extensions/pyspecific.py @@ -164,6 +164,19 @@ class PyCoroutineMethod(PyCoroutineMixin, PyClassmember): return PyClassmember.run(self) +class PyAbstractMethod(PyClassmember): + + def handle_signature(self, sig, signode): + ret = super(PyAbstractMethod, self).handle_signature(sig, signode) + signode.insert(0, addnodes.desc_annotation('abstractmethod ', + 'abstractmethod ')) + return ret + + def run(self): + self.name = 'py:method' + return PyClassmember.run(self) + + # Support for documenting version of removal in deprecations class DeprecatedRemoved(Directive): @@ -368,5 +381,6 @@ def setup(app): app.add_directive_to_domain('py', 'decoratormethod', PyDecoratorMethod) app.add_directive_to_domain('py', 'coroutinefunction', PyCoroutineFunction) app.add_directive_to_domain('py', 'coroutinemethod', PyCoroutineMethod) + app.add_directive_to_domain('py', 'abstractmethod', PyAbstractMethod) app.add_directive('miscnews', MiscNews) return {'version': '1.0', 'parallel_read_safe': True} |