Analisi di file .rst con direttive specifiche della Sfinge a livello di programmazione

Question

Vorrei poter analizzare la prima volta con sphinx in Python per ulteriori elaborazioni e verifiche. Qualcosa di simile:

import sphinx 
p = sphinx.parse("/path/to/file.rst") 
do_something_with(p) 

Sembra che qualcosa è possibile in docutils utilizzando il docutils.core.publish_file:

publish_file(open("/path/to/file.rst") 

Ma che non sa nulla di sfinge direttive specifiche, ecc ...

Answer 1

È possibile utilizzare Sphinx Extensions per eseguire l'elaborazione personalizzata prima della scrittura finale. C'è un ottimo progetto di esempio per iniziare nella documentazione che illustra vari hook che consentono di personalizzare Sphinx.

A seconda di cosa si sta tentando di fare, potrebbe essere necessario fornire la propria funzione do_something come argomento di richiamata a uno di questi eventi.

doctree-resolved(app, doctree, docname) 
html-page-context(app, pagename, templatename, context, doctree) 

E poi si può estendere la sfinge come segue

def setup(app): 
    app.connect('doctree-resolved', do_something) 

Se l'esempio nel tutorial Sfinge non è abbastanza dettagliata, Doug Hellmann ha anche un blog post sulla creazione di un correttore ortografico per la Sfinge. Ho trovato un riferimento utile per l'estensione Sfinge che dovevo scrivere qualche tempo fa.