.. | .. |
---|
3 | 3 | .. note:: Per leggere la documentazione originale in inglese: |
---|
4 | 4 | :ref:`Documentation/doc-guide/index.rst <doc_guide>` |
---|
5 | 5 | |
---|
| 6 | +.. _it_sphinxdoc: |
---|
| 7 | + |
---|
6 | 8 | Introduzione |
---|
7 | 9 | ============ |
---|
8 | 10 | |
---|
.. | .. |
---|
33 | 35 | ==================== |
---|
34 | 36 | |
---|
35 | 37 | I marcatori ReST utilizzati nei file in Documentation/ sono pensati per essere |
---|
36 | | -processati da ``Sphinx`` nella versione 1.3 o superiore. Se desiderate produrre |
---|
37 | | -un documento PDF è raccomandato l'utilizzo di una versione superiore alle 1.4.6. |
---|
| 38 | +processati da ``Sphinx`` nella versione 1.3 o superiore. |
---|
38 | 39 | |
---|
39 | 40 | Esiste uno script che verifica i requisiti Sphinx. Per ulteriori dettagli |
---|
40 | 41 | consultate :ref:`it_sphinx-pre-install`. |
---|
.. | .. |
---|
66 | 67 | utilizzando LaTeX. Per una corretta interpretazione, è necessario aver |
---|
67 | 68 | installato texlive con i pacchetti amdfonts e amsmath. |
---|
68 | 69 | |
---|
69 | | -Riassumendo, se volete installare la versione 1.4.9 di Sphinx dovete eseguire:: |
---|
| 70 | +Riassumendo, se volete installare la versione 1.7.9 di Sphinx dovete eseguire:: |
---|
70 | 71 | |
---|
71 | | - $ virtualenv sphinx_1.4 |
---|
72 | | - $ . sphinx_1.4/bin/activate |
---|
73 | | - (sphinx_1.4) $ pip install -r Documentation/sphinx/requirements.txt |
---|
| 72 | + $ virtualenv sphinx_1.7.9 |
---|
| 73 | + $ . sphinx_1.7.9/bin/activate |
---|
| 74 | + (sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt |
---|
74 | 75 | |
---|
75 | | -Dopo aver eseguito ``. sphinx_1.4/bin/activate``, il prompt cambierà per |
---|
| 76 | +Dopo aver eseguito ``. sphinx_1.7.9/bin/activate``, il prompt cambierà per |
---|
76 | 77 | indicare che state usando il nuovo ambiente. Se aprite un nuova sessione, |
---|
77 | 78 | prima di generare la documentazione, dovrete rieseguire questo comando per |
---|
78 | 79 | rientrare nell'ambiente virtuale. |
---|
.. | .. |
---|
118 | 119 | You should run: |
---|
119 | 120 | |
---|
120 | 121 | sudo dnf install -y texlive-luatex85 |
---|
121 | | - /usr/bin/virtualenv sphinx_1.4 |
---|
122 | | - . sphinx_1.4/bin/activate |
---|
| 122 | + /usr/bin/virtualenv sphinx_1.7.9 |
---|
| 123 | + . sphinx_1.7.9/bin/activate |
---|
123 | 124 | pip install -r Documentation/sphinx/requirements.txt |
---|
124 | 125 | |
---|
125 | 126 | Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468. |
---|
.. | .. |
---|
241 | 242 | * Per inserire blocchi di testo con caratteri a dimensione fissa (codici di |
---|
242 | 243 | esempio, casi d'uso, eccetera): utilizzate ``::`` quando non è necessario |
---|
243 | 244 | evidenziare la sintassi, specialmente per piccoli frammenti; invece, |
---|
244 | | - utilizzate ``.. code-block:: <language>`` per blocchi di più lunghi che |
---|
245 | | - potranno beneficiare dell'avere la sintassi evidenziata. |
---|
| 245 | + utilizzate ``.. code-block:: <language>`` per blocchi più lunghi che |
---|
| 246 | + beneficeranno della sintassi evidenziata. Per un breve pezzo di codice da |
---|
| 247 | + inserire nel testo, usate \`\`. |
---|
246 | 248 | |
---|
247 | 249 | |
---|
248 | 250 | Il dominio C |
---|
.. | .. |
---|
266 | 268 | |
---|
267 | 269 | Il nome della funzione (per esempio ioctl) rimane nel testo ma il nome del suo |
---|
268 | 270 | riferimento cambia da ``ioctl`` a ``VIDIOC_LOG_STATUS``. Anche la voce |
---|
269 | | -nell'indice cambia in ``VIDIOC_LOG_STATUS`` e si potrà quindi fare riferimento |
---|
270 | | -a questa funzione scrivendo: |
---|
| 271 | +nell'indice cambia in ``VIDIOC_LOG_STATUS``. |
---|
271 | 272 | |
---|
272 | | -.. code-block:: rst |
---|
273 | | - |
---|
274 | | - :c:func:`VIDIOC_LOG_STATUS` |
---|
| 273 | +Notate che per una funzione non c'è bisogno di usare ``c:func:`` per generarne |
---|
| 274 | +i riferimenti nella documentazione. Grazie a qualche magica estensione a |
---|
| 275 | +Sphinx, il sistema di generazione della documentazione trasformerà |
---|
| 276 | +automaticamente un riferimento ad una ``funzione()`` in un riferimento |
---|
| 277 | +incrociato quando questa ha una voce nell'indice. Se trovate degli usi di |
---|
| 278 | +``c:func:`` nella documentazione del kernel, sentitevi liberi di rimuoverli. |
---|
275 | 279 | |
---|
276 | 280 | |
---|
277 | 281 | Tabelle a liste |
---|