Titolo del Read the Docs

cultura della documentazione

Questo progetto è solo una dimostrazione dell’esposizione di contenuti su Read the Docs.

Questa è solo una bozza

Il repository dello schema tipo RTD si trova a questo link, da potere clonare per progetti di documentazione online.

Questo Read the Docs è uno schema tipo ottimizzato (per design e setting vari) per la pubblicazione di documenti. Settaggi quali colore della colonna sinistra e colori del testo dei paragrafi, titoli, ecc., possono essere cambiati nel file theme_override.css.

Altre impostazioni di visualizzazione grafica del documento su Read the Docs possono essere effettuate sui seguenti file, all’interno della cartella _templates:

  • breadcrumbs.html
  • footer.html
  • layout.html
  • searchbox.html
  • versions.html

Importante

Le impostazioni dentro il repository Github di questo progetto permettono di usare sia file in formato .rST (reStructuredText), che in formato .MD (Markdown). Le istruzioni da inserire nel file conf.py sono dettagliate in questa ricetta di Tansignari.