[Python-checkins] cpython (2.7): update part of sphinxext
sandro.tosi
python-checkins at python.org
Sat Jan 14 16:54:12 CET 2012
http://hg.python.org/cpython/rev/76aa98f69251
changeset: 74396:76aa98f69251
branch: 2.7
user: Sandro Tosi <sandro.tosi at gmail.com>
date: Sat Jan 14 16:42:21 2012 +0100
summary:
update part of sphinxext
files:
Doc/tools/sphinxext/pyspecific.py | 141 +++++++++-
Doc/tools/sphinxext/static/copybutton.js | 4 +-
2 files changed, 118 insertions(+), 27 deletions(-)
diff --git a/Doc/tools/sphinxext/pyspecific.py b/Doc/tools/sphinxext/pyspecific.py
--- a/Doc/tools/sphinxext/pyspecific.py
+++ b/Doc/tools/sphinxext/pyspecific.py
@@ -5,7 +5,7 @@
Sphinx extension with Python doc-specific markup.
- :copyright: 2008-2011 by Georg Brandl.
+ :copyright: 2008, 2009, 2010 by Georg Brandl.
:license: Python license.
"""
@@ -13,6 +13,7 @@
SOURCE_URI = 'http://hg.python.org/cpython/file/2.7/%s'
from docutils import nodes, utils
+from sphinx.util.nodes import split_explicit_title
# monkey-patch reST parser to disable alphabetic and roman enumerated lists
from docutils.parsers.rst.states import Body
@@ -48,8 +49,10 @@
# Support for linking to Python source files easily
def source_role(typ, rawtext, text, lineno, inliner, options={}, content=[]):
- path = utils.unescape(text)
- refnode = nodes.reference(path, path, refuri=SOURCE_URI % path)
+ has_t, title, target = split_explicit_title(text)
+ title = utils.unescape(title)
+ target = utils.unescape(target)
+ refnode = nodes.reference(title, title, refuri=SOURCE_URI % target)
return [refnode], []
@@ -81,26 +84,85 @@
return [pnode]
+# Support for documenting decorators
+
+from sphinx import addnodes
+from sphinx.domains.python import PyModulelevel, PyClassmember
+
+class PyDecoratorMixin(object):
+ def handle_signature(self, sig, signode):
+ ret = super(PyDecoratorMixin, self).handle_signature(sig, signode)
+ signode.insert(0, addnodes.desc_addname('@', '@'))
+ return ret
+
+ def needs_arglist(self):
+ return False
+
+class PyDecoratorFunction(PyDecoratorMixin, PyModulelevel):
+ def run(self):
+ # a decorator function is a function after all
+ self.name = 'py:function'
+ return PyModulelevel.run(self)
+
+class PyDecoratorMethod(PyDecoratorMixin, PyClassmember):
+ def run(self):
+ self.name = 'py:method'
+ return PyClassmember.run(self)
+
+
+# Support for documenting version of removal in deprecations
+
+from sphinx.locale import versionlabels
+from sphinx.util.compat import Directive
+
+versionlabels['deprecated-removed'] = \
+ 'Deprecated since version %s, will be removed in version %s'
+
+class DeprecatedRemoved(Directive):
+ has_content = True
+ required_arguments = 2
+ optional_arguments = 1
+ final_argument_whitespace = True
+ option_spec = {}
+
+ def run(self):
+ node = addnodes.versionmodified()
+ node.document = self.state.document
+ node['type'] = 'deprecated-removed'
+ version = (self.arguments[0], self.arguments[1])
+ node['version'] = version
+ if len(self.arguments) == 3:
+ inodes, messages = self.state.inline_text(self.arguments[2],
+ self.lineno+1)
+ node.extend(inodes)
+ if self.content:
+ self.state.nested_parse(self.content, self.content_offset, node)
+ ret = [node] + messages
+ else:
+ ret = [node]
+ env = self.state.document.settings.env
+ env.note_versionchange('deprecated', version[0], node, self.lineno)
+ return ret
+
+
# Support for building "topic help" for pydoc
pydoc_topic_labels = [
'assert', 'assignment', 'atom-identifiers', 'atom-literals',
'attribute-access', 'attribute-references', 'augassign', 'binary',
'bitwise', 'bltin-code-objects', 'bltin-ellipsis-object',
- 'bltin-file-objects', 'bltin-null-object', 'bltin-type-objects', 'booleans',
- 'break', 'callable-types', 'calls', 'class', 'coercion-rules',
- 'comparisons', 'compound', 'context-managers', 'continue', 'conversions',
- 'customization', 'debugger', 'del', 'dict', 'dynamic-features', 'else',
- 'exceptions', 'exec', 'execmodel', 'exprlists', 'floating', 'for',
- 'formatstrings', 'function', 'global', 'id-classes', 'identifiers', 'if',
- 'imaginary', 'import', 'in', 'integers', 'lambda', 'lists', 'naming',
- 'numbers', 'numeric-types', 'objects', 'operator-summary', 'pass', 'power',
- 'print', 'raise', 'return', 'sequence-methods', 'sequence-types',
- 'shifting', 'slicings', 'specialattrs', 'specialnames',
- 'string-conversions', 'string-methods', 'strings', 'subscriptions', 'truth',
- 'try', 'types', 'typesfunctions', 'typesmapping', 'typesmethods',
- 'typesmodules', 'typesseq', 'typesseq-mutable', 'unary', 'while', 'with',
- 'yield'
+ 'bltin-null-object', 'bltin-type-objects', 'booleans',
+ 'break', 'callable-types', 'calls', 'class', 'comparisons', 'compound',
+ 'context-managers', 'continue', 'conversions', 'customization', 'debugger',
+ 'del', 'dict', 'dynamic-features', 'else', 'exceptions', 'execmodel',
+ 'exprlists', 'floating', 'for', 'formatstrings', 'function', 'global',
+ 'id-classes', 'identifiers', 'if', 'imaginary', 'import', 'in', 'integers',
+ 'lambda', 'lists', 'naming', 'nonlocal', 'numbers', 'numeric-types',
+ 'objects', 'operator-summary', 'pass', 'power', 'raise', 'return',
+ 'sequence-types', 'shifting', 'slicings', 'specialattrs', 'specialnames',
+ 'string-methods', 'strings', 'subscriptions', 'truth', 'try', 'types',
+ 'typesfunctions', 'typesmapping', 'typesmethods', 'typesmodules',
+ 'typesseq', 'typesseq-mutable', 'unary', 'while', 'with', 'yield'
]
from os import path
@@ -130,16 +192,16 @@
for label in self.status_iterator(pydoc_topic_labels,
'building topics... ',
length=len(pydoc_topic_labels)):
- if label not in self.env.labels:
+ if label not in self.env.domaindata['std']['labels']:
self.warn('label %r not in documentation' % label)
continue
- docname, labelid, sectname = self.env.labels[label]
+ docname, labelid, sectname = self.env.domaindata['std']['labels'][label]
doctree = self.env.get_and_resolve_doctree(docname, self)
document = new_document('<section node>')
document.append(doctree.ids[labelid])
destination = StringOutput(encoding='utf-8')
writer.write(document, destination)
- self.topics[label] = writer.output
+ self.topics[label] = str(writer.output)
def finish(self):
f = open(path.join(self.outdir, 'topics.py'), 'w')
@@ -158,9 +220,8 @@
# Support for documenting Opcodes
import re
-from sphinx import addnodes
-opcode_sig_re = re.compile(r'(\w+(?:\+\d)?)\s*\((.*)\)')
+opcode_sig_re = re.compile(r'(\w+(?:\+\d)?)(?:\s*\((.*)\))?')
def parse_opcode_signature(env, sig, signode):
"""Transform an opcode signature into RST nodes."""
@@ -169,18 +230,48 @@
raise ValueError
opname, arglist = m.groups()
signode += addnodes.desc_name(opname, opname)
- paramlist = addnodes.desc_parameterlist()
- signode += paramlist
- paramlist += addnodes.desc_parameter(arglist, arglist)
+ if arglist is not None:
+ paramlist = addnodes.desc_parameterlist()
+ signode += paramlist
+ paramlist += addnodes.desc_parameter(arglist, arglist)
return opname.strip()
+# Support for documenting pdb commands
+
+pdbcmd_sig_re = re.compile(r'([a-z()!]+)\s*(.*)')
+
+# later...
+#pdbargs_tokens_re = re.compile(r'''[a-zA-Z]+ | # identifiers
+# [.,:]+ | # punctuation
+# [\[\]()] | # parens
+# \s+ # whitespace
+# ''', re.X)
+
+def parse_pdb_command(env, sig, signode):
+ """Transform a pdb command signature into RST nodes."""
+ m = pdbcmd_sig_re.match(sig)
+ if m is None:
+ raise ValueError
+ name, args = m.groups()
+ fullname = name.replace('(', '').replace(')', '')
+ signode += addnodes.desc_name(name, name)
+ if args:
+ signode += addnodes.desc_addname(' '+args, ' '+args)
+ return fullname
+
+
def setup(app):
app.add_role('issue', issue_role)
app.add_role('source', source_role)
app.add_directive('impl-detail', ImplementationDetail)
+ app.add_directive('deprecated-removed', DeprecatedRemoved)
app.add_builder(PydocTopicsBuilder)
app.add_builder(suspicious.CheckSuspiciousMarkupBuilder)
app.add_description_unit('opcode', 'opcode', '%s (opcode)',
parse_opcode_signature)
+ app.add_description_unit('pdbcommand', 'pdbcmd', '%s (pdb command)',
+ parse_pdb_command)
app.add_description_unit('2to3fixer', '2to3fixer', '%s (2to3 fixer)')
+ app.add_directive_to_domain('py', 'decorator', PyDecoratorFunction)
+ app.add_directive_to_domain('py', 'decoratormethod', PyDecoratorMethod)
diff --git a/Doc/tools/sphinxext/static/copybutton.js b/Doc/tools/sphinxext/static/copybutton.js
--- a/Doc/tools/sphinxext/static/copybutton.js
+++ b/Doc/tools/sphinxext/static/copybutton.js
@@ -8,8 +8,8 @@
// get the styles from the current theme
pre.parent().parent().css('position', 'relative');
- var hide_text = 'Hide the prompts and ouput';
- var show_text = 'Show the prompts and ouput';
+ var hide_text = 'Hide the prompts and output';
+ var show_text = 'Show the prompts and output';
var border_width = pre.css('border-top-width');
var border_style = pre.css('border-top-style');
var border_color = pre.css('border-top-color');
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list