Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Docutils: traverse sections?

How can I traverse each of the section names of a document in Sphinx?

(and where is the documentation for docutils? It is maddeningly difficult to find anything useful beyond the Sphinx Application API; even looking at the source code for docutils/nodes.py doesn't add much help. )

like image 778
Jason S Avatar asked Aug 26 '16 17:08

Jason S


1 Answers

Finally figured it out through trial and error :/

import docutils

def doctree_resolved(app, doctree, docname):
    for section in doctree.traverse(docutils.nodes.section):
        title = section.next_node(docutils.nodes.Titular)
        if title:
            print title.astext()

def setup(app):
    app.connect('doctree-resolved', doctree_resolved)
like image 140
Jason S Avatar answered Nov 10 '22 22:11

Jason S