diff options
| author | Dmitry Shachnev <mitya57@gmail.com> | 2017-05-17 13:09:12 +0300 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2017-05-24 09:13:26 -0400 |
| commit | f370bfb10878918eae8db9985e0856949fa65d3a (patch) | |
| tree | 239b829d90c0d5b03df07a643b66a901157bab15 /docs | |
| parent | 6092ea8fa62191bf9ed8ebaae3125dcde9c4bbec (diff) | |
Fixed docs build with Sphinx 1.6.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 6 | ||||
| -rw-r--r-- | docs/_ext/djangodocs.py | 9 | ||||
| -rw-r--r-- | docs/conf.py | 6 |
3 files changed, 13 insertions, 8 deletions
diff --git a/docs/Makefile b/docs/Makefile index f57db99699..39f84ec0e3 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -9,10 +9,14 @@ PAPER ?= BUILDDIR ?= _build 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. PAPEROPT_a4 = -D latex_paper_size=a4 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 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . diff --git a/docs/_ext/djangodocs.py b/docs/_ext/djangodocs.py index d86568d6c7..eb0b216739 100644 --- a/docs/_ext/djangodocs.py +++ b/docs/_ext/djangodocs.py @@ -13,7 +13,10 @@ from sphinx.domains.std import Cmdoption from sphinx.util.compat import Directive from sphinx.util.console import bold 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 simple_option_desc_re = re.compile( @@ -226,7 +229,7 @@ class VersionDirective(Directive): return ret -class DjangoHTMLTranslator(SmartyPantsHTMLTranslator): +class DjangoHTMLTranslator(HTMLTranslator): """ Django-specific reST to HTML tweaks. """ @@ -287,7 +290,7 @@ class DjangoHTMLTranslator(SmartyPantsHTMLTranslator): old_ids = node.get('ids', []) node['ids'] = ['s-' + i for i in old_ids] node['ids'].extend(old_ids) - SmartyPantsHTMLTranslator.visit_section(self, node) + super().visit_section(node) node['ids'] = old_ids diff --git a/docs/conf.py b/docs/conf.py index e9619afdbf..2344e71dcf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,6 +48,8 @@ extensions = [ # Add it only if spelling check is requested so docs can be generated without it. if 'spelling' in sys.argv: extensions.append("sphinxcontrib.spelling") + # Workaround for https://bitbucket.org/dhellmann/sphinxcontrib-spelling/issues/13 + html_use_smartypants = False # Spelling language. spelling_lang = 'en_US' @@ -182,10 +184,6 @@ html_theme_path = ["_theme"] # using the given strftime format. 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. # html_index = '' |