[Python-checkins] r86256 - python/branches/py3k/Doc/tools/sphinxext/pyspecific.py

[georg.brandl]

Author: georg.brandl
Date: Sat Nov  6 08:19:35 2010
New Revision: 86256

Log:
#10334: add a role to refer to Python source files in SVN.

Modified:
   python/branches/py3k/Doc/tools/sphinxext/pyspecific.py

Modified: python/branches/py3k/Doc/tools/sphinxext/pyspecific.py
==============================================================================
--- python/branches/py3k/Doc/tools/sphinxext/pyspecific.py	(original)
+++ python/branches/py3k/Doc/tools/sphinxext/pyspecific.py	Sat Nov  6 08:19:35 2010
@@ -10,8 +10,10 @@
 """
 
 ISSUE_URI = 'http://bugs.python.org/issue%s'
+SOURCE_URI = 'http://svn.python.org/view/python/branches/py3k/%s?view=markup'
 
 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
@@ -44,6 +46,16 @@
     return [refnode], []
 
 
+# Support for linking to Python source files easily
+
+def source_role(typ, rawtext, text, lineno, inliner, options={}, content=[]):
+    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], []
+
+
 # Support for marking up implementation details
 
 from sphinx.util.compat import Directive
@@ -214,6 +226,7 @@
 
 def setup(app):
     app.add_role('issue', issue_role)
+    app.add_role('source', source_role)
     app.add_directive('impl-detail', ImplementationDetail)
     app.add_builder(PydocTopicsBuilder)
     app.add_builder(suspicious.CheckSuspiciousMarkupBuilder)