mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-30 06:34:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

fix deprecated-removed directive with sphinx 1.2

Browse source
This commit is contained in:
Georg Brandl 2014-01-21 19:20:31 +01:00
parent eed1661b47
commit 7ed509a38f
2 changed files with 24 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

32
Doc/tools/sphinxext/pyspecific.py
View file

@ -5,7 +5,7 @@
Sphinx extension with Python doc-specific markup. Sphinx extension with Python doc-specific markup.
:copyright: 2008-2013 by Georg Brandl. :copyright: 2008-2014 by Georg Brandl.
:license: Python license. :license: Python license.
""" """
@ -145,8 +145,6 @@ class PyDecoratorMethod(PyDecoratorMixin, PyClassmember):
from sphinx.locale import versionlabels from sphinx.locale import versionlabels
from sphinx.util.compat import Directive from sphinx.util.compat import Directive
versionlabels['deprecated-removed'] = \
'Deprecated since version %s, will be removed in version %s'
class DeprecatedRemoved(Directive): class DeprecatedRemoved(Directive):
has_content = True has_content = True
@ -155,24 +153,40 @@ class DeprecatedRemoved(Directive):
final_argument_whitespace = True final_argument_whitespace = True
option_spec = {} option_spec = {}
_label = 'Deprecated since version %s, will be removed in version %s'
def run(self): def run(self):
node = addnodes.versionmodified() node = addnodes.versionmodified()
node.document = self.state.document node.document = self.state.document
node['type'] = 'deprecated-removed' node['type'] = 'deprecated-removed'
version = (self.arguments[0], self.arguments[1]) version = (self.arguments[0], self.arguments[1])
node['version'] = version node['version'] = version
text = self._label % version
if len(self.arguments) == 3: if len(self.arguments) == 3:
inodes, messages = self.state.inline_text(self.arguments[2], inodes, messages = self.state.inline_text(self.arguments[2],
self.lineno+1) self.lineno+1)
node.extend(inodes) para = nodes.paragraph(self.arguments[2], '', *inodes)
if self.content: node.append(para)
self.state.nested_parse(self.content, self.content_offset, node)
ret = [node] + messages
else: else:
ret = [node] messages = []
if self.content:
self.state.nested_parse(self.content, self.content_offset, node)
if len(node):
if isinstance(node[0], nodes.paragraph) and node[0].rawsource:
content = nodes.inline(node[0].rawsource, translatable=True)
content.source = node[0].source
content.line = node[0].line
content += node[0].children
node[0].replace_self(nodes.paragraph('', '', content))
node[0].insert(0, nodes.inline('', '%s: ' % text,
classes=['versionmodified']))
else:
para = nodes.paragraph('', '',
nodes.inline('', '%s.' % text, classes=['versionmodified']))
node.append(para)
env = self.state.document.settings.env env = self.state.document.settings.env
env.note_versionchange('deprecated', version[0], node, self.lineno) env.note_versionchange('deprecated', version[0], node, self.lineno)
return ret return [node] + messages
# Support for including Misc/NEWS # Support for including Misc/NEWS

2
Doc/tools/sphinxext/static/basic.css
View file

@ -342,7 +342,7 @@ dl.glossary dt {
padding: 7px; padding: 7px;
} }
div.deprecated p { div.deprecated p, div.deprecated-removed p {
margin-bottom: 0; margin-bottom: 0;
} }