User Tools

Site Tools


doc:appunti:software:rst_sphinx

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
doc:appunti:software:rst_sphinx [2012/02/10 15:44] – [Aggiunta di un documento] niccolodoc:appunti:software:rst_sphinx [2012/11/21 10:24] (current) – [Personalizzare lo stile di rst2pdf] niccolo
Line 4: Line 4:
   * [[http://sphinx.pocoo.org/index.html|Sphinx]]   * [[http://sphinx.pocoo.org/index.html|Sphinx]]
  
 +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, in particolare è in grado di trasformare una gerarchia di documenti .rst in una risorsa facilmente navigabile con un browser (''make html''). La [[http://docs.python.org/|documentazione ufficiale sul sito di Python]] è generata con Sphinx.
 ===== Installazione ===== ===== Installazione =====
  
Line 75: Line 76:
 </code> </code>
  
-I file ''logo_faunalia.png'' e ''favicon_faunalia.ico'' possono stare nella directory radice (verranno copiati in ''_build/html/_static/'' durante il build).+I file ''logo_faunalia.png'' e ''favicon_faunalia.ico'' possono stare nella directory radice (verranno copiati in **''_build/html/_static/''** durante il build). Il foglio di stile personalizzato deve essere messo in **''_static/''**, come prima istruzione carica il foglio di stile predefinito: 
 + 
 +<code css> 
 +@import url('default.css'); 
 +</code>
 ===== Aggiunta di un documento ===== ===== Aggiunta di un documento =====
  
-Si crea una sottodirectory, ad esempio ''manuale_postgis'', dentro la quale si mette il documento, es. 'manuale_postgis.rst'', le immagini, ecc.+Si crea una sottodirectory, ad esempio ''manuale_postgis'', dentro la quale si mette il documento, es. ''manuale_postgis.rst'', le immagini, ecc.
  
 Nel file **''index.rst''** si aggiunge un riferimento al documento: Nel file **''index.rst''** si aggiunge un riferimento al documento:
Line 144: Line 149:
  
 <file> <file>
-tyles:+styles:
     headertable:     headertable:
         parent: table         parent: table
doc/appunti/software/rst_sphinx.1328885045.txt.gz · Last modified: 2012/02/10 15:44 by niccolo