diff options
author | Georg Brandl <georg@python.org> | 2012-10-10 14:45:11 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2012-10-10 14:45:11 (GMT) |
commit | 3a2e101be564ffcb73dac708533d9178d90c2da8 (patch) | |
tree | d48c0e22d21a2be1509bbc69a700d7b8ddf9a788 /Doc/tools/sphinxext | |
parent | 4614cc4f7fcdc4537ea98fc49308719b71093972 (diff) | |
download | cpython-3a2e101be564ffcb73dac708533d9178d90c2da8.zip cpython-3a2e101be564ffcb73dac708533d9178d90c2da8.tar.gz cpython-3a2e101be564ffcb73dac708533d9178d90c2da8.tar.bz2 |
Issue #12947: revert earlier workaround and use a monkey-patch to enable showing doctest directives only in the doctest docs.
Diffstat (limited to 'Doc/tools/sphinxext')
-rw-r--r-- | Doc/tools/sphinxext/pyspecific.py | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/Doc/tools/sphinxext/pyspecific.py b/Doc/tools/sphinxext/pyspecific.py index 89bb86f..9b2cc47 100644 --- a/Doc/tools/sphinxext/pyspecific.py +++ b/Doc/tools/sphinxext/pyspecific.py @@ -33,9 +33,38 @@ def new_visit_versionmodified(self, node): self.body.append('<span class="versionmodified">%s</span> ' % text) from sphinx.writers.html import HTMLTranslator +from sphinx.writers.latex import LaTeXTranslator from sphinx.locale import versionlabels HTMLTranslator.visit_versionmodified = new_visit_versionmodified +HTMLTranslator.visit_versionmodified = new_visit_versionmodified +# monkey-patch HTML and LaTeX translators to keep doctest blocks in the +# doctest docs themselves +orig_visit_literal_block = HTMLTranslator.visit_literal_block +def new_visit_literal_block(self, node): + meta = self.builder.env.metadata[self.builder.current_docname] + old_trim_doctest_flags = self.highlighter.trim_doctest_flags + if 'keepdoctest' in meta: + self.highlighter.trim_doctest_flags = False + try: + orig_visit_literal_block(self, node) + finally: + self.highlighter.trim_doctest_flags = old_trim_doctest_flags + +HTMLTranslator.visit_literal_block = new_visit_literal_block + +orig_depart_literal_block = LaTeXTranslator.depart_literal_block +def new_depart_literal_block(self, node): + meta = self.builder.env.metadata[self.curfilestack[-1]] + old_trim_doctest_flags = self.highlighter.trim_doctest_flags + if 'keepdoctest' in meta: + self.highlighter.trim_doctest_flags = False + try: + orig_depart_literal_block(self, node) + finally: + self.highlighter.trim_doctest_flags = old_trim_doctest_flags + +LaTeXTranslator.depart_literal_block = new_depart_literal_block # Support for marking up and linking to bugs.python.org issues |