Lines Matching +full:pre +full:- +full:packaged
9 .. _Sphinx: http://www.sphinx-doc.org/
13 documentation comments, or kernel-doc comments, from source files. Usually these
15 kernel-doc comments have some special structure and formatting, but beyond that
32 :ref:`sphinx-pre-install` for further details.
40 Sphinx inside a virtual environment, using ``virtualenv-3``
41 or ``virtualenv``, depending on how your distribution packaged Python 3.
61 (sphinx_1.4) $ pip install -r Documentation/sphinx/requirements.txt
69 ------------
81 --------------------
91 .. _sphinx-pre-install:
94 --------------------------------
100 $ ./scripts/sphinx-pre-install
102 Warning: better to also install "texlive-luatex85".
105 sudo dnf install -y texlive-luatex85
108 pip install -r Documentation/sphinx/requirements.txt
110 Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.
119 ``--no-pdf``
122 ``--no-virtualenv``
132 format-specific subdirectories under ``Documentation/output``.
134 To generate documentation, Sphinx (``sphinx-build``) must obviously be
138 All of these are widely available and packaged in distributions.
141 variable. For example, use ``make SPHINXOPTS=-v htmldocs`` to get more verbose
154 .. _TOC tree: http://www.sphinx-doc.org/en/stable/markup/toctree.html
168 .. _reStructuredText Primer: http://www.sphinx-doc.org/en/stable/rest.html
169 .. _Sphinx specific markup constructs: http://www.sphinx-doc.org/en/stable/markup/index.html
172 ------------------------------------------------
200 3. ``-`` for sections::
203 -------
218 ``.. code-block:: <language>`` for longer code blocks that benefit
223 ------------
228 .. code-block:: rst
232 The C domain of the kernel-doc has some additional features. E.g. you can
236 .. code-block:: rst
241 The func-name (e.g. ioctl) remains in the output but the ref-name changed from
245 .. code-block:: rst
251 -----------
254 double-stage lists. Compared to the ASCII-art they might not be as
260 The ``flat-table`` is a double-stage list similar to the ``list-table`` with
263 * column-span: with the role ``cspan`` a cell can be extended through
266 * row-span: with the role ``rspan`` a cell can be extended through
270 side of that table-row. With Option ``:fill-cells:`` this behavior can
276 * ``:header-rows:`` [int] count of header rows
277 * ``:stub-columns:`` [int] count of stub columns
279 * ``:fill-cells:`` instead of auto-spanning missing cells, insert missing cells
287 list is the *table-row*. In the *table-row* there is only one markup allowed,
288 the list of the cells in this *table-row*. Exceptions are *comments* ( ``..`` )
292 .. code-block:: rst
294 .. flat-table:: table title
297 * - head col 1
298 - head col 2
299 - head col 3
300 - head col 4
302 * - column 1
303 - field 1.1
304 - field 1.2 with autospan
306 * - column 2
307 - field 2.1
308 - :rspan:`1` :cspan:`1` field 2.2 - 3.3
312 - column 3
316 .. flat-table:: table title
319 * - head col 1
320 - head col 2
321 - head col 3
322 - head col 4
324 * - column 1
325 - field 1.1
326 - field 1.2 with autospan
328 * - column 2
329 - field 2.1
330 - :rspan:`1` :cspan:`1` field 2.2 - 3.3
334 - column 3
341 If you want to add an image, you should use the ``kernel-figure`` and
342 ``kernel-image`` directives. E.g. to insert a figure with a scalable
345 .. kernel-figure:: svg_image.svg
352 .. kernel-figure:: svg_image.svg
360 * Graphviz: http://www.graphviz.org/content/dot-language
364 .. kernel-figure:: hello.dot
371 .. kernel-figure:: hello.dot
377 ``kernel-render`` directives.::
379 .. kernel-render:: DOT
384 "bar" -> "baz";
389 *literal-block* (:ref:`hello_dot_render`).
393 .. kernel-render:: DOT
398 "bar" -> "baz";
408 .. kernel-render:: SVG
410 :alt: so-nw-arrow
412 <?xml version="1.0" encoding="UTF-8"?>
419 .. kernel-render:: SVG
421 :alt: so-nw-arrow
423 <?xml version="1.0" encoding="UTF-8"?>
426 <line x1="180" y1="370" x2="500" y2="50" stroke="black" stroke-width="15px"/>