Skip to content

Commit

Permalink
bpo-35293: Remove RemovedInSphinx40Warning (GH-22198)
Browse files Browse the repository at this point in the history
* bpo-35293: Remove RemovedInSphinx40Warning

* Update Misc/NEWS.d/next/Documentation/2020-09-12-17-37-13.bpo-35293._cOwPD.rst

Co-authored-by: Victor Stinner <vstinner@python.org>

* bpo-35293: Apply Victor's review

Co-authored-by: Victor Stinner <vstinner@python.org>
(cherry picked from commit 6595cb0)

Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
  • Loading branch information
miss-islington and corona10 committed Sep 18, 2020
1 parent c5cddc1 commit b7cdea8
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 15 deletions.
36 changes: 21 additions & 15 deletions Doc/tools/extensions/pyspecific.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,12 @@
from sphinx.util.nodes import split_explicit_title
from sphinx.writers.text import TextWriter, TextTranslator
from sphinx.writers.latex import LaTeXTranslator
from sphinx.domains.python import PyModulelevel, PyClassmember

try:
from sphinx.domains.python import PyFunction, PyMethod
except ImportError:
from sphinx.domains.python import PyClassmember as PyMethod
from sphinx.domains.python import PyModulelevel as PyFunction

# Support for checking for suspicious markup

Expand Down Expand Up @@ -238,17 +243,18 @@ def needs_arglist(self):
return False


class PyDecoratorFunction(PyDecoratorMixin, PyModulelevel):
class PyDecoratorFunction(PyDecoratorMixin, PyFunction):
def run(self):
# a decorator function is a function after all
self.name = 'py:function'
return PyModulelevel.run(self)
return PyFunction.run(self)


class PyDecoratorMethod(PyDecoratorMixin, PyClassmember):
# TODO: Use sphinx.domains.python.PyDecoratorMethod when possible
class PyDecoratorMethod(PyDecoratorMixin, PyMethod):
def run(self):
self.name = 'py:method'
return PyClassmember.run(self)
return PyMethod.run(self)


class PyCoroutineMixin(object):
Expand All @@ -265,31 +271,31 @@ def handle_signature(self, sig, signode):
return ret


class PyCoroutineFunction(PyCoroutineMixin, PyModulelevel):
class PyCoroutineFunction(PyCoroutineMixin, PyFunction):
def run(self):
self.name = 'py:function'
return PyModulelevel.run(self)
return PyFunction.run(self)


class PyCoroutineMethod(PyCoroutineMixin, PyClassmember):
class PyCoroutineMethod(PyCoroutineMixin, PyMethod):
def run(self):
self.name = 'py:method'
return PyClassmember.run(self)
return PyMethod.run(self)


class PyAwaitableFunction(PyAwaitableMixin, PyClassmember):
class PyAwaitableFunction(PyAwaitableMixin, PyFunction):
def run(self):
self.name = 'py:function'
return PyClassmember.run(self)
return PyFunction.run(self)


class PyAwaitableMethod(PyAwaitableMixin, PyClassmember):
class PyAwaitableMethod(PyAwaitableMixin, PyMethod):
def run(self):
self.name = 'py:method'
return PyClassmember.run(self)
return PyMethod.run(self)


class PyAbstractMethod(PyClassmember):
class PyAbstractMethod(PyMethod):

def handle_signature(self, sig, signode):
ret = super(PyAbstractMethod, self).handle_signature(sig, signode)
Expand All @@ -299,7 +305,7 @@ def handle_signature(self, sig, signode):

def run(self):
self.name = 'py:method'
return PyClassmember.run(self)
return PyMethod.run(self)


# Support for documenting version of removal in deprecations
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix RemovedInSphinx40Warning when building the documentation. Patch by Dong-hee Na.

0 comments on commit b7cdea8

Please sign in to comment.