Lines Matching +full:pre +full:- +full:packaged
11 .. _Sphinx: http://www.sphinx-doc.org/
15 documentation comments, or kernel-doc comments, from source files. Usually these
17 kernel-doc comments have some special structure and formatting, but beyond that
33 :ref:`sphinx-pre-install` for further details.
41 Sphinx inside a virtual environment, using ``virtualenv-3``
42 or ``virtualenv``, depending on how your distribution packaged Python 3.
62 (sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt
70 ------------
82 --------------------
92 .. _sphinx-pre-install:
95 --------------------------------
101 $ ./scripts/sphinx-pre-install
103 Warning: better to also install "texlive-luatex85".
106 sudo dnf install -y texlive-luatex85
109 pip install -r Documentation/sphinx/requirements.txt
111 Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.
120 ``--no-pdf``
123 ``--no-virtualenv``
133 format-specific subdirectories under ``Documentation/output``.
135 To generate documentation, Sphinx (``sphinx-build``) must obviously be
139 All of these are widely available and packaged in distributions.
142 variable. For example, use ``make SPHINXOPTS=-v htmldocs`` to get more verbose
155 .. _TOC tree: http://www.sphinx-doc.org/en/stable/markup/toctree.html
169 .. _reStructuredText Primer: http://www.sphinx-doc.org/en/stable/rest.html
170 .. _Sphinx specific markup constructs: http://www.sphinx-doc.org/en/stable/markup/index.html
173 ------------------------------------------------
201 3. ``-`` for sections::
204 -------
219 ``.. code-block:: <language>`` for longer code blocks that benefit
224 ------------
229 .. code-block:: rst
233 The C domain of the kernel-doc has some additional features. E.g. you can
237 .. code-block:: rst
242 The func-name (e.g. ioctl) remains in the output but the ref-name changed from
255 -----------
258 double-stage lists. Compared to the ASCII-art they might not be as
264 The ``flat-table`` is a double-stage list similar to the ``list-table`` with
267 * column-span: with the role ``cspan`` a cell can be extended through
270 * row-span: with the role ``rspan`` a cell can be extended through
274 side of that table-row. With Option ``:fill-cells:`` this behavior can
280 * ``:header-rows:`` [int] count of header rows
281 * ``:stub-columns:`` [int] count of stub columns
283 * ``:fill-cells:`` instead of auto-spanning missing cells, insert missing cells
291 list is the *table-row*. In the *table-row* there is only one markup allowed,
292 the list of the cells in this *table-row*. Exceptions are *comments* ( ``..`` )
296 .. code-block:: rst
298 .. flat-table:: table title
301 * - head col 1
302 - head col 2
303 - head col 3
304 - head col 4
306 * - column 1
307 - field 1.1
308 - field 1.2 with autospan
310 * - column 2
311 - field 2.1
312 - :rspan:`1` :cspan:`1` field 2.2 - 3.3
316 - column 3
320 .. flat-table:: table title
323 * - head col 1
324 - head col 2
325 - head col 3
326 - head col 4
328 * - column 1
329 - field 1.1
330 - field 1.2 with autospan
332 * - column 2
333 - field 2.1
334 - :rspan:`1` :cspan:`1` field 2.2 - 3.3
338 - column 3
340 Cross-referencing
341 -----------------
343 Cross-referencing from one documentation page to another can be done by passing
345 For example, to cross-reference to this page (the .rst extension is optional)::
347 See Documentation/doc-guide/sphinx.rst.
354 For information on cross-referencing to kernel-doc functions or types, see
355 Documentation/doc-guide/kernel-doc.rst.
362 If you want to add an image, you should use the ``kernel-figure`` and
363 ``kernel-image`` directives. E.g. to insert a figure with a scalable
366 .. kernel-figure:: svg_image.svg
373 .. kernel-figure:: svg_image.svg
381 * Graphviz: http://www.graphviz.org/content/dot-language
385 .. kernel-figure:: hello.dot
392 .. kernel-figure:: hello.dot
398 ``kernel-render`` directives.::
400 .. kernel-render:: DOT
405 "bar" -> "baz";
410 *literal-block* (:ref:`hello_dot_render`).
414 .. kernel-render:: DOT
419 "bar" -> "baz";
429 .. kernel-render:: SVG
431 :alt: so-nw-arrow
433 <?xml version="1.0" encoding="UTF-8"?>
440 .. kernel-render:: SVG
442 :alt: so-nw-arrow
444 <?xml version="1.0" encoding="UTF-8"?>
447 <line x1="180" y1="370" x2="500" y2="50" stroke="black" stroke-width="15px"/>