test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed docs build with Sphinx 1.6.

This commit is contained in:
Dmitry Shachnev 2017-05-17 13:09:12 +03:00 committed by Tim Graham
parent 6092ea8fa6
commit f370bfb108
3 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Makefile
View File

@ -9,10 +9,14 @@ PAPER ?=
BUILDDIR ?= _build BUILDDIR ?= _build
LANGUAGE ?= LANGUAGE ?=
# Convert something like "en_US" to "en", because Sphinx does not recognize
# underscores. Country codes should be passed using a dash, e.g. "pt-BR".
LANGUAGEOPT = $(firstword $(subst _, ,$(LANGUAGE)))
# Internal variables. # Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -n -d $(BUILDDIR)/doctrees -D language=$(LANGUAGE) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . ALLSPHINXOPTS = -n -d $(BUILDDIR)/doctrees -D language=$(LANGUAGEOPT) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others # the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

9
docs/_ext/djangodocs.py
View File

@ -13,7 +13,10 @@ from sphinx.domains.std import Cmdoption
from sphinx.util.compat import Directive from sphinx.util.compat import Directive
from sphinx.util.console import bold from sphinx.util.console import bold
from sphinx.util.nodes import set_source_info from sphinx.util.nodes import set_source_info
from sphinx.writers.html import SmartyPantsHTMLTranslator try:
from sphinx.writers.html import SmartyPantsHTMLTranslator as HTMLTranslator
except ImportError: # Sphinx 1.6+
from sphinx.writers.html import HTMLTranslator
# RE for option descriptions without a '--' prefix # RE for option descriptions without a '--' prefix
simple_option_desc_re = re.compile( simple_option_desc_re = re.compile(
@ -226,7 +229,7 @@ class VersionDirective(Directive):
return ret return ret
class DjangoHTMLTranslator(SmartyPantsHTMLTranslator): class DjangoHTMLTranslator(HTMLTranslator):
""" """
Django-specific reST to HTML tweaks. Django-specific reST to HTML tweaks.
""" """
@ -287,7 +290,7 @@ class DjangoHTMLTranslator(SmartyPantsHTMLTranslator):
old_ids = node.get('ids', []) old_ids = node.get('ids', [])
node['ids'] = ['s-' + i for i in old_ids] node['ids'] = ['s-' + i for i in old_ids]
node['ids'].extend(old_ids) node['ids'].extend(old_ids)
SmartyPantsHTMLTranslator.visit_section(self, node) super().visit_section(node)
node['ids'] = old_ids node['ids'] = old_ids

6
docs/conf.py
View File

@ -48,6 +48,8 @@ extensions = [
# Add it only if spelling check is requested so docs can be generated without it. # Add it only if spelling check is requested so docs can be generated without it.
if 'spelling' in sys.argv: if 'spelling' in sys.argv:
extensions.append("sphinxcontrib.spelling") extensions.append("sphinxcontrib.spelling")
# Workaround for https://bitbucket.org/dhellmann/sphinxcontrib-spelling/issues/13
html_use_smartypants = False
# Spelling language. # Spelling language.
spelling_lang = 'en_US' spelling_lang = 'en_US'
@ -182,10 +184,6 @@ html_theme_path = ["_theme"]
# using the given strftime format. # using the given strftime format.
html_last_updated_fmt = '%b %d, %Y' html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
html_use_smartypants = True
# Content template for the index page. # Content template for the index page.
# html_index = '' # html_index = ''