CODEWITHSUNDEEP
python-sphinxdocutils
Jason S
Jason S

Reputation: 189626

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. )

Upvotes: 6

Views: 807

Answers (1)

Jason S
Jason S

Reputation: 189626

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)

Upvotes: 7

Related Questions