Back to index

python3.2  3.2.2
Public Member Functions | Public Attributes | Static Public Attributes
pyspecific.PydocTopicsBuilder Class Reference
Inheritance diagram for pyspecific.PydocTopicsBuilder:
Inheritance graph
[legend]
Collaboration diagram for pyspecific.PydocTopicsBuilder:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def init
def get_outdated_docs
def get_target_uri
def write
def finish

Public Attributes

 topics

Static Public Attributes

string name = 'pydoc-topics'

Detailed Description

Definition at line 178 of file pyspecific.py.


Member Function Documentation

Definition at line 206 of file pyspecific.py.

00206 
00207     def finish(self):
00208         f = open(path.join(self.outdir, 'topics.py'), 'w')
00209         try:
00210             f.write('# Autogenerated by Sphinx on %s\n' % asctime())
00211             f.write('topics = ' + pformat(self.topics) + '\n')
00212         finally:
00213             f.close()
00214 
00215 
00216 # Support for checking for suspicious markup

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 184 of file pyspecific.py.

00184 
00185     def get_outdated_docs(self):
00186         return 'all pydoc topics'

def pyspecific.PydocTopicsBuilder.get_target_uri (   self,
  docname,
  typ = None 
)

Definition at line 187 of file pyspecific.py.

00187 
00188     def get_target_uri(self, docname, typ=None):
00189         return ''  # no URIs

Definition at line 181 of file pyspecific.py.

00181 
00182     def init(self):
00183         self.topics = {}

Here is the caller graph for this function:

def pyspecific.PydocTopicsBuilder.write (   self,
  ignored 
)

Definition at line 190 of file pyspecific.py.

00190 
00191     def write(self, *ignored):
00192         writer = TextWriter(self)
00193         for label in self.status_iterator(pydoc_topic_labels,
00194                                           'building topics... ',
00195                                           length=len(pydoc_topic_labels)):
00196             if label not in self.env.domaindata['std']['labels']:
00197                 self.warn('label %r not in documentation' % label)
00198                 continue
00199             docname, labelid, sectname = self.env.domaindata['std']['labels'][label]
00200             doctree = self.env.get_and_resolve_doctree(docname, self)
00201             document = new_document('<section node>')
00202             document.append(doctree.ids[labelid])
00203             destination = StringOutput(encoding='utf-8')
00204             writer.write(document, destination)
00205             self.topics[label] = str(writer.output)

Here is the call graph for this function:


Member Data Documentation

Definition at line 179 of file pyspecific.py.

Definition at line 182 of file pyspecific.py.


The documentation for this class was generated from the following file: