blob: 8947c738a18bacb0e5408c591c7ec111fdd127f7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
---
language: restructured text (RST)
filename: restructuredtext-it.rst
contributors:
- ["DamienVGN", "https://github.com/martin-damien"]
- ["Andre Polykanine", "https://github.com/Oire"]
translators:
- ["Ale46", "https://github.com/Ale46"]
lang: it-it
---
RST è un formato di file formalmente creato dalla comunità Python per scrivere documentazione (e quindi fa parte di Docutils).
I file RST sono semplici file di testo con una sintassi leggera (in confronto all'HTML).
## Installazione
Per usare Restructured Text, sarà necessario installare [Python](http://www.python.org) ed il pacchetto `docutils`.
`docutils` può essere installato da riga di comando:
```bash
$ easy_install docutils
```
O se il tuo sistema ha `pip`, puoi usare anche lui:
```bash
$ pip install docutils
```
## Sintassi del file
Un semplice esempio della sintassi del file:
```
.. Le righe che iniziano con due punti sono comandi speciali. Ma se non è possibile trovare alcun comando, la riga viene considerata come un commento
===============================================================================
I titoli principali sono scritti utilizzando caratteri di uguale, sopra e sotto
===============================================================================
Si noti che devono esistere tanti caratteri di uguale quanti sono i caratteri del titolo.
Anche il titolo è sottolineato con caratteri di uguale
======================================================
Sottotitoli con i trattini
--------------------------
E sotto-sottotitoli con tildi
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Puoi inserire il testo in *corsivo* o in **grassetto**, puoi "contrassegnare" il testo come codice con un doppio apice ``: `` print () ``.
Le liste sono semplici come in Markdown:
- primo articolo
- Secondo elemento
- Sottoelemento
o
* Primo elemento
* Secondo elemento
* Sottoelemento
Le tabelle sono davvero facili da scrivere:
=========== ========
Stato Capitale
=========== ========
Francia Parigi
Giappone Tokio
=========== ========
Le tabelle più complesse possono essere fatte facilmente (colonne e/o righe unite) ma ti suggerisco di leggere il documento completo per questo :)
Esistono diversi modi per creare collegamenti:
- Aggiungendo un underscore dopo una parola: Github_ e aggiungendo l'URL di destinazione dopo il testo (questo modo ha il vantaggio di non inserire URL non necessari all'interno del testo leggibile).
- Digitando un URL completo: https://github.com/ (verrà automaticamente convertito in un collegamento)
- Facendo un collegamento simile a Markdown: `Github <https://github.com/>`_ .
.. _Github https://github.com/
```
## Come usarlo
RST viene fornito con docutils che dispone di `rst2html`, per esempio:
```bash
$ rst2html miofile.rst output.html
```
*Nota : In alcuni sistemi il comando potrebbe essere rst2html.py*
Ma ci sono applicazioni più complesse che utilizzano il formato RST:
- [Pelican](http://blog.getpelican.com/), un generatore di siti statici
- [Sphinx](http://sphinx-doc.org/), un generatore di documentazione
- e molti altri
## Letture
- [Riferimento ufficiale rapido](http://docutils.sourceforge.net/docs/user/rst/quickref.html)
|
