doc:appunti:software:rst_sphinx
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:appunti:software:rst_sphinx [2012/02/10 15:34] – [Installazione] niccolo | doc:appunti:software:rst_sphinx [2012/11/21 10:24] (current) – [Personalizzare lo stile di rst2pdf] niccolo | ||
---|---|---|---|
Line 4: | Line 4: | ||
* [[http:// | * [[http:// | ||
+ | Il progetto **reStructuredText** (abbreviato in reST) nasce per la documentazione dei progetti scritti in Python, ma in generale può essere usato come linguaggio di markup per scrivere documentazione. Sphinx invece è un sistema per la generazione della documentazione, | ||
===== Installazione ===== | ===== Installazione ===== | ||
Line 55: | Line 56: | ||
===== Personalizzazione del tema ===== | ===== Personalizzazione del tema ===== | ||
- | Scegliere un tema tra [[http:// | + | Scegliere un tema tra [[http:// |
<code python> | <code python> | ||
Line 75: | Line 76: | ||
</ | </ | ||
- | I file '' | + | I file '' |
+ | |||
+ | <code css> | ||
+ | @import url(' | ||
+ | </ | ||
===== Aggiunta di un documento ===== | ===== Aggiunta di un documento ===== | ||
+ | |||
+ | Si crea una sottodirectory, | ||
Nel file **'' | Nel file **'' | ||
Line 88: | Line 95: | ||
| | ||
</ | </ | ||
+ | |||
+ | Per generare la documentazione HTML si esegue: | ||
< | < | ||
make html | make html | ||
+ | </ | ||
+ | |||
+ | Il risultato viene creato in **'' | ||
+ | |||
+ | Per generare il PDF complessivo di tutti i documenti si esegue: | ||
+ | |||
+ | < | ||
+ | make latexpdf | ||
+ | </ | ||
+ | |||
+ | In questo caso lo stile non è dei migliori, secondo me è preferibile quello utilizzato da **'' | ||
+ | |||
+ | ===== Personalizzare lo stile di rst2pdf ===== | ||
+ | |||
+ | Ad esempio vogliamo creare una tabella per header e footer, senza bordo. Il **'' | ||
+ | |||
+ | < | ||
+ | .. |rigacci_org| image:: images/ | ||
+ | : | ||
+ | :alt: Rigacci.Org | ||
+ | |||
+ | .. |cc-by-nc-sa| image:: images/ | ||
+ | : | ||
+ | :alt: cc-by-nc-sa | ||
+ | |||
+ | .. header:: | ||
+ | |||
+ | .. class:: headertable | ||
+ | |||
+ | +---------------+--------------------------------------------+ | ||
+ | | |.. class:: centered | ||
+ | | | ||
+ | | |rigacci_org| | PostgreSQL/ | ||
+ | +---------------+--------------------------------------------+ | ||
+ | |||
+ | .. footer:: | ||
+ | |||
+ | .. class:: headertable | ||
+ | |||
+ | +------------------------+-----------------+ | ||
+ | | |.. class:: right | | ||
+ | | | | | ||
+ | | ### | ||
+ | +------------------------+-----------------+ | ||
+ | </ | ||
+ | |||
+ | Si crea un foglio di stile **'' | ||
+ | |||
+ | < | ||
+ | styles: | ||
+ | headertable: | ||
+ | parent: table | ||
+ | commands: [] | ||
+ | [VALIGN, [ 0, 0 ], [ -1, -1 ], CENTER ] | ||
+ | [ROWBACKGROUNDS, | ||
+ | </ | ||
+ | |||
+ | e quindi si crea il PDF: | ||
+ | |||
+ | < | ||
+ | rst2pdf -s custom-pdf.style documento.rst | ||
</ | </ |
doc/appunti/software/rst_sphinx.1328884457.txt.gz · Last modified: 2012/02/10 15:34 by niccolo