summaryrefslogtreecommitdiff
path: root/docs/_ext/djangodocs.py
diff options
context:
space:
mode:
authorMalcolm Tredinnick <malcolm.tredinnick@gmail.com>2009-03-09 01:37:17 +0000
committerMalcolm Tredinnick <malcolm.tredinnick@gmail.com>2009-03-09 01:37:17 +0000
commit059765fa6c273af584ad255eb1395dea6f0e2307 (patch)
tree106475a805b005f7bb177369a303449fa30a5847 /docs/_ext/djangodocs.py
parentfedea84f3ce4d58d4fb2d5d15f142443da760f32 (diff)
downloaddjango-059765fa6c273af584ad255eb1395dea6f0e2307.tar.gz
Fixed #9436 -- Updated docs build code to create "new in development version".
Patch from Marc Fargas. git-svn-id: http://code.djangoproject.com/svn/django/trunk@10006 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/_ext/djangodocs.py')
-rw-r--r--docs/_ext/djangodocs.py31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/_ext/djangodocs.py b/docs/_ext/djangodocs.py
index bda7d3e4ce..65a823e10b 100644
--- a/docs/_ext/djangodocs.py
+++ b/docs/_ext/djangodocs.py
@@ -10,6 +10,8 @@ import sphinx.builder
import sphinx.directives
import sphinx.environment
import sphinx.htmlwriter
+import sphinx.roles
+from docutils import nodes
def setup(app):
app.add_crossref_type(
@@ -44,11 +46,40 @@ def setup(app):
indextemplate = "pair: %s; django-admin command-line option",
parse_node = lambda env, sig, signode: sphinx.directives.parse_option_desc(signode, sig),
)
+ app.add_config_value('django_next_version', '0.0', True)
+ app.add_directive('versionadded', parse_version_directive, 1, (1, 1, 1))
+ app.add_directive('versionchanged', parse_version_directive, 1, (1, 1, 1))
app.add_transform(SuppressBlockquotes)
# Monkeypatch PickleHTMLBuilder so that it doesn't die in Sphinx 0.4.2
if sphinx.__version__ == '0.4.2':
monkeypatch_pickle_builder()
+
+def parse_version_directive(name, arguments, options, content, lineno,
+ content_offset, block_text, state, state_machine):
+ env = state.document.settings.env
+ is_nextversion = env.config.django_next_version == arguments[0]
+ ret = []
+ node = sphinx.addnodes.versionmodified()
+ ret.append(node)
+ if not is_nextversion:
+ if len(arguments) == 1:
+ linktext = 'Please, see the release notes <releases-%s>' % (arguments[0])
+ xrefs = sphinx.roles.xfileref_role('ref', linktext, linktext, lineno, state)
+ node.extend(xrefs[0])
+ node['version'] = arguments[0]
+ else:
+ node['version'] = "Development version"
+ node['type'] = name
+ if len(arguments) == 2:
+ inodes, messages = state.inline_text(arguments[1], lineno+1)
+ node.extend(inodes)
+ if content:
+ state.nested_parse(content, content_offset, node)
+ ret = ret + messages
+ env.note_versionchange(node['type'], node['version'], node, lineno)
+ return ret
+
class SuppressBlockquotes(docutils.transforms.Transform):
"""