Più pagine html in uscita da un documento .rst in Django

Question

Sto scrivendo un'applicazione Django per servire un po 'di documentazione scritta in reStructuredText. Ho molti documenti scritti in * .rst, ciascuno di essi è piuttosto lungo, con molte sezioni, sottosezione e così via.

Visualizza l'intero documento in una singola pagina non è un problema utilizzando i filtri Django, ma preferirei avere solo l'indice argomento su una prima pagina, Pentecoste link ad un URL in cui posso visualizzare una singola sezione / sottosezione (che avrà bisogno di un po 'indietro | successivo fino | | casa' collegamento immagino ...). In un modo simile ad un 'uscita pagina HTML multiple' come in un docbook / XML per la conversione HTML.

Qualcuno mi può punto in una certa direzione per costruire un albero del documento di un documento * .rst una una singola sezione di esso parse, o suggerire un modo intelligente per ottenere un risultato simile?

Answer 1

La scelta 1. Includere collegamenti URL alle altre parti del documento.

si scrive un index.rst, part1.rst, part2.rst, ecc E il vostro ha index.rst collegamenti alle altre parti. Ciò richiede quasi nessun lavoro, ad eccezione di un'attenta pianificazione per assicurarsi che il vostro link RST HTML sono corrette.

Non c'è "parse". Basta rompere il documento in sezioni. Manualmente.

[Questo sembra così ovvio, ho paura di parlarne.]

Sfinge . Gestisce table-of-contenuti e connessioni tra documenti molto bene.

Tuttavia, le estensioni Sphinx a RST non sono gestiti direttamente da Django, così avresti bisogno di salvare l'output Sfinge e quindi visualizzare che in Django. Usiamo il JSON HTML Builder ( http: // sfinge .pocoo.org / builders.html? culminante = json # sphinx.builders.html.JSONHTMLBuilder ) in uscita dal Sfinge. Poi rendiamo questi documenti attraverso un modello.