Skip to content

[2.7] fix pydoc-topics to work with Sphinx 1.7 (GH-6475) #6502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benjaminp merged 2 commits into from
Apr 17, 2018
Merged

[2.7] fix pydoc-topics to work with Sphinx 1.7 (GH-6475) #6502

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff01797
[2.7] fix pydoc-topics to work with Sphinx 1.7 (GH-6475)
benjaminp Apr 17, 2018
63af280
add missing import
benjaminp Apr 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions Doc/tools/extensions/pyspecific.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@
from docutils import nodes, utils
from docutils.parsers.rst import Directive

from sphinx.util import status_iterator
from sphinx.util.nodes import split_explicit_title
from sphinx.writers.html import HTMLTranslator
from sphinx.writers.latex import LaTeXTranslator
from sphinx.writers.text import TextTranslator

# monkey-patch reST parser to disable alphabetic and roman enumerated lists
from docutils.parsers.rst.states import Body
Expand Down Expand Up @@ -158,8 +160,11 @@ def run(self):
class PydocTopicsBuilder(Builder):
name = 'pydoc-topics'

default_translator_class = TextTranslator

def init(self):
self.topics = {}
self.secnumbers = {}

def get_outdated_docs(self):
return 'all pydoc topics'
Expand All @@ -169,9 +174,9 @@ def get_target_uri(self, docname, typ=None):

def write(self, *ignored):
writer = TextWriter(self)
for label in self.status_iterator(pydoc_topic_labels,
'building topics... ',
length=len(pydoc_topic_labels)):
for label in status_iterator(pydoc_topic_labels,
'building topics... ',
length=len(pydoc_topic_labels)):
if label not in self.env.domaindata['std']['labels']:
self.warn('label %r not in documentation' % label)
continue
Expand Down