Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. (fad4a932) · Commits · Dom Sekotill / django

docs/Makefile

+54 −13

Original line number	Diff line number	Diff line
		@@ -12,17 +12,23 @@ PAPEROPT_a4 = -D latex_paper_size=a4
		PAPEROPT_letter = -D latex_paper_size=letter
		ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

		.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
		.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest

		help:
		@echo "Please use \`make <target>' where <target> is one of"
		@echo " html to make standalone HTML files"
		@echo " dirhtml to make HTML files named index.html in directories"
		@echo " singlehtml to make a single large HTML file"
		@echo " pickle to make pickle files"
		@echo " json to make JSON files"
		@echo " htmlhelp to make HTML files and a HTML help project"
		@echo " qthelp to make HTML files and a qthelp project"
		@echo " devhelp to make HTML files and a Devhelp project"
		@echo " epub to make an epub"
		@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
		@echo " latexpdf to make LaTeX files and run them through pdflatex"
		@echo " text to make text files"
		@echo " man to make manual pages"
		@echo " changes to make an overview of all changed/added/deprecated items"
		@echo " linkcheck to check all external links for integrity"
		@echo " doctest to run all doctests embedded in the documentation (if enabled)"
		@@ -40,6 +46,11 @@ dirhtml:
		@echo
		@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

		singlehtml:
		$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
		@echo
		@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

		pickle:
		$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
		@echo
		@@ -65,12 +76,42 @@ qthelp:
		@echo "To view the help file:"
		@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django.qhc"

		devhelp:
		$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
		@echo
		@echo "Build finished."
		@echo "To view the help file:"
		@echo "# mkdir -p $$HOME/.local/share/devhelp/django"
		@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django"
		@echo "# devhelp"

		epub:
		$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
		@echo
		@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

		latex:
		$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
		@echo
		@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
		@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
		"run these through (pdf)latex."
		@echo "Run \`make' in that directory to run these through (pdf)latex" \
		"(use \`make latexpdf' here to do that automatically)."

		latexpdf:
		$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
		@echo "Running LaTeX files through pdflatex..."
		make -C $(BUILDDIR)/latex all-pdf
		@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

		text:
		$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
		@echo
		@echo "Build finished. The text files are in $(BUILDDIR)/text."

		man:
		$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
		@echo
		@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

		changes:
		$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

docs/_ext/djangodocs.py

+17 −6

Original line number	Diff line number	Diff line
		@@ -88,7 +88,10 @@ def parse_version_directive(name, arguments, options, content, lineno,
		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)
		try:
		xrefs = sphinx.roles.XRefRole()('ref', linktext, linktext, lineno, state) # Sphinx >= 1.0
		except:
		xrefs = sphinx.roles.xfileref_role('ref', linktext, linktext, lineno, state) # Sphinx < 1.0
		node.extend(xrefs[0])
		node['version'] = arguments[0]
		else:
		@@ -159,7 +162,7 @@ class DjangoHTMLTranslator(sphinx_htmlwriter.SmartyPantsHTMLTranslator):
		# better callout -- the Sphinx default is just a little span,
		# which is a bit less obvious that I'd like.
		#
		# FIXME: these messages are all hardcoded in English. We need to chanage
		# FIXME: these messages are all hardcoded in English. We need to change
		# that to accomodate other language docs, but I can't work out how to make
		# that work and I think it'll require Sphinx 0.5 anyway.
		#
		@@ -212,7 +215,10 @@ def parse_django_admin_node(env, sig, signode):
		def parse_django_adminopt_node(env, sig, signode):
		"""A copy of sphinx.directives.CmdoptionDesc.parse_signature()"""
		from sphinx import addnodes
		from sphinx.directives.desc import option_desc_re
		try:
		from sphinx.domains.std import option_desc_re # Sphinx >= 1.0
		except:
		from sphinx.directives.desc import option_desc_re # Sphinx < 1.0
		count = 0
		firstname = ''
		for m in option_desc_re.finditer(sig):
		@@ -278,9 +284,14 @@ class DjangoStandaloneHTMLBuilder(builders_html.StandaloneHTMLBuilder):
		self.warn("cannot create templatebuiltins.js due to missing simplejson dependency")
		return
		self.info(bold("writing templatebuiltins.js..."))
		try:
		xrefs = self.env.reftargets.keys()
		templatebuiltins = dict([('ttags', [n for (t,n) in xrefs if t == 'ttag']),
		('tfilters', [n for (t,n) in xrefs if t == 'tfilter'])])
		except AttributeError:
		xrefs = self.env.domaindata["std"]["objects"]
		templatebuiltins = dict([('ttags', [n for (t,n) in xrefs if t == 'templatetag']),
		('tfilters', [n for (t,n) in xrefs if t == 'templatefilter'])])
		outfilename = os.path.join(self.outdir, "templatebuiltins.js")
		f = open(outfilename, 'wb')
		f.write('var django_template_builtins = ')

docs/_templates/genindex.html→docs/_theme/djangodocs/genindex.html

+1 −1

Original line number	Diff line number	Diff line
		{% extends "!genindex.html" %}
		{% extends "basic/genindex.html" %}

		{% block bodyclass %}{% endblock %}
		{% block sidebarwrapper %}{% endblock %}
		No newline at end of file

docs/_templates/layout.html→docs/_theme/djangodocs/layout.html

+2 −2

Original line number	Diff line number	Diff line
		{% extends "!layout.html" %}
		{% extends "basic/layout.html" %}

		{%- macro secondnav() %}
		{%- if prev %}
		@@ -61,7 +61,7 @@
		<a title="Home page" href="{{ pathto('index') }}">Home</a> {{ reldelim2 }}
		<a title="Table of contents" href="{{ pathto('contents') }}">Table of contents</a> {{ reldelim2 }}
		<a title="Global index" href="{{ pathto('genindex') }}">Index</a> {{ reldelim2 }}
		<a title="Module index" href="{{ pathto('modindex') }}">Modules</a>
		<a title="Module index" href="{{ pathto('py-modindex') }}">Modules</a>
		</div>
		<div class="nav">{{ secondnav() }}</div>
		</div>

docs/_templates/modindex.html→docs/_theme/djangodocs/modindex.html

+1 −1

Original line number	Diff line number	Diff line
		{% extends "!modindex.html" %}
		{% extends "basic/modindex.html" %}
		{% block bodyclass %}{% endblock %}
		{% block sidebarwrapper %}{% endblock %}
		No newline at end of file