it_IT/doc-guide/sphinx.rst

1 .. include:: ../disclaimer-ita.rst
4 	  :ref:`Documentation/doc-guide/index.rst <doc_guide>`
18 .. _Sphinx: http://www.sphinx-doc.org/
22 includere i commenti di documentazione, o di tipo kernel-doc, dai file
25 e l'architettura del codice. I commenti di tipo kernel-doc hanno una struttura
42 consultate :ref:`it_sphinx-pre-install`.
52 ``virtualenv-3`` o ``virtualenv`` a seconda di come Python 3 è stato
70        (sphinx_2.4.4) $ pip install -r Documentation/sphinx/requirements.txt
78 ----------------------
90 --------------------------
102 .. _it_sphinx-pre-install:
105 -------------------------------
108 Sphinx. Se lo script riesce a riconoscere la vostra distribuzione, allora
112 	$ ./scripts/sphinx-pre-install
114 	Warning: better to also install "texlive-luatex85".
117 		sudo dnf install -y texlive-luatex85
120 		pip install -r Documentation/sphinx/requirements.txt
122 	Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.
132 ``--no-pdf``
135 ``--no-virtualenv``
150 Ovviamente, per generare la documentazione, Sphinx (``sphinx-build``)
161 la generazione potete usare il seguente comando ``make SPHINXOPTS=-v htmldocs``.
168 ``Documentation/doc-guide`` eseguendo ``make SPHINXDIRS=doc-guide htmldocs``. La
189 .. _TOC tree: http://www.sphinx-doc.org/en/stable/markup/toctree.html
205 .. _`manuale introduttivo a reStructuredText`: http://www.sphinx-doc.org/en/stable/rest.html
206 .. _`costruttori specifici per Sphinx`: http://www.sphinx-doc.org/en/stable/markup/index.html
209 --------------------------------------------
238   3. ``-`` per le sezioni::
241        -------
256   utilizzate ``.. code-block:: <language>`` per blocchi più lunghi che
262 ------------
267 .. code-block:: rst
271 Il dominio C per kernel-doc ha delle funzionalità aggiuntive. Per esempio,
275 .. code-block:: rst
293 ---------------
295 Il formato ``list-table`` può essere utile per tutte quelle tabelle che non
296 possono essere facilmente scritte usando il formato ASCII-art di Sphinx. Però,
301 La ``flat-table`` è anch'essa una lista di liste simile alle ``list-table``
304 * column-span: col ruolo ``cspan`` una cella può essere estesa attraverso
307 * raw-span: col ruolo ``rspan`` una cella può essere estesa attraverso
310 * auto-span: la cella più a destra viene estesa verso destra per compensare
311   la mancanza di celle. Con l'opzione ``:fill-cells:`` questo comportamento
312   può essere cambiato da *auto-span* ad *auto-fill*, il quale inserisce
317 * ``:header-rows:``   [int] conta le righe di intestazione
318 * ``:stub-columns:``  [int] conta le colonne di stub
320 * ``:fill-cells:``    invece di estendere automaticamente una cella su quelle
334 .. code-block:: rst
336    .. flat-table:: table title
339       * - head col 1
340         - head col 2
341         - head col 3
342         - head col 4
344       * - row 1
345         - field 1.1
346         - field 1.2 with autospan
348       * - row 2
349         - field 2.1
350         - :rspan:`1` :cspan:`1` field 2.2 - 3.3
354         - row 3
358    .. flat-table:: table title
361       * - head col 1
362         - head col 2
363         - head col 3
364         - head col 4
366       * - row 1
367         - field 1.1
368         - field 1.2 with autospan
370       * - row 2
371         - field 2.1
372         - :rspan:`1` :cspan:`1` field 2.2 - 3.3
376         - row 3
379 ----------------------
389     Vedere Documentation/doc-guide/sphinx.rst. Questo funziona sempre
405 kernel-doc per funzioni o tipi, consultate
412 Se volete aggiungere un'immagine, utilizzate le direttive ``kernel-figure``
413 e ``kernel-image``. Per esempio, per inserire una figura di un'immagine in
416     .. kernel-figure::  ../../../doc-guide/svg_image.svg
423 .. kernel-figure::  ../../../doc-guide/svg_image.svg
432 * Graphviz: http://www.graphviz.org/content/dot-language
436   .. kernel-figure::  ../../../doc-guide/hello.dot
443 .. kernel-figure::  ../../../doc-guide/hello.dot
448 Tramite la direttiva ``kernel-render`` è possibile aggiungere codice specifico;
451   .. kernel-render:: DOT
456       "bar" -> "baz";
465 .. kernel-render:: DOT
470       "bar" -> "baz";
481   .. kernel-render:: SVG
483      :alt: so-nw-arrow
485      <?xml version="1.0" encoding="UTF-8"?>
492 .. kernel-render:: SVG
494    :alt: so-nw-arrow
496    <?xml version="1.0" encoding="UTF-8"?>
499    <line x1="180" y1="370" x2="500" y2="50" stroke="black" stroke-width="15px"/>