Lines Matching +full:pre +full:- +full:packaged
12 .. _Sphinx: http://www.sphinx-doc.org/
16 documentation comments, or kernel-doc comments, from source files. Usually these
18 kernel-doc comments have some special structure and formatting, but beyond that
34 :ref:`sphinx-pre-install` for further details.
42 Sphinx inside a virtual environment, using ``virtualenv-3``
43 or ``virtualenv``, depending on how your distribution packaged Python 3.
50 (sphinx_latest) $ pip install -r Documentation/sphinx/requirements.txt
58 ------------
69 --------------------
80 ------------------------
89 The former was the only option for pre-6.1 kernel documentation and it
97 .. _imgmath: https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.imgmath
98 .. _mathjax: https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.mathjax
100 .. _sphinx-pre-install:
103 --------------------------------
109 $ ./scripts/sphinx-pre-install
111 Warning: better to also install "texlive-luatex85".
114 sudo dnf install -y texlive-luatex85
117 pip install -r Documentation/sphinx/requirements.txt
119 Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.
128 ``--no-pdf``
131 ``--no-virtualenv``
135 ---------------------------------
146 /usr/bin/python3.9 -m venv sphinx_min
148 pip install -r Documentation/sphinx/min_requirements.txt
164 format-specific subdirectories under ``Documentation/output``.
166 To generate documentation, Sphinx (``sphinx-build``) must obviously be
169 widely available and packaged in distributions.
172 variable. For example, use ``make SPHINXOPTS=-v htmldocs`` to get more verbose
190 under ``Documentation/doc-guide`` by running
191 ``make SPHINXDIRS=doc-guide htmldocs``.
202 -----------------------
241 .. _TOC tree: http://www.sphinx-doc.org/en/stable/markup/toctree.html
255 .. _reStructuredText Primer: http://www.sphinx-doc.org/en/stable/rest.html
256 .. _Sphinx specific markup constructs: http://www.sphinx-doc.org/en/stable/markup/index.html
259 ------------------------------------------------
287 3. ``-`` for sections::
290 -------
305 ``.. code-block:: <language>`` for longer code blocks that benefit
310 ------------
315 .. code-block:: rst
319 The C domain of the kernel-doc has some additional features. E.g. you can
323 .. code-block:: rst
328 The func-name (e.g. ioctl) remains in the output but the ref-name changed from
340 ------
352 The list-table formats can be useful for tables that are not easily laid
353 out in the usual Sphinx ASCII-art formats. These formats are nearly
354 impossible for readers of the plain-text documents to understand, though,
358 The ``flat-table`` is a double-stage list similar to the ``list-table`` with
361 * column-span: with the role ``cspan`` a cell can be extended through
364 * row-span: with the role ``rspan`` a cell can be extended through
368 side of that table-row. With Option ``:fill-cells:`` this behavior can
374 * ``:header-rows:`` [int] count of header rows
375 * ``:stub-columns:`` [int] count of stub columns
377 * ``:fill-cells:`` instead of auto-spanning missing cells, insert missing cells
385 list is the *table-row*. In the *table-row* there is only one markup allowed,
386 the list of the cells in this *table-row*. Exceptions are *comments* ( ``..`` )
390 .. code-block:: rst
392 .. flat-table:: table title
395 * - head col 1
396 - head col 2
397 - head col 3
398 - head col 4
400 * - row 1
401 - field 1.1
402 - field 1.2 with autospan
404 * - row 2
405 - field 2.1
406 - :rspan:`1` :cspan:`1` field 2.2 - 3.3
410 - row 3
414 .. flat-table:: table title
417 * - head col 1
418 - head col 2
419 - head col 3
420 - head col 4
422 * - row 1
423 - field 1.1
424 - field 1.2 with autospan
426 * - row 2
427 - field 2.1
428 - :rspan:`1` :cspan:`1` field 2.2 - 3.3
432 - row 3
434 Cross-referencing
435 -----------------
437 Cross-referencing from one documentation page to another can be done simply by
440 "Documentation/". For example, to cross-reference to this page, all the
444 See Documentation/doc-guide/sphinx.rst. This always works.
458 For information on cross-referencing to kernel-doc functions or types, see
459 Documentation/doc-guide/kernel-doc.rst.
475 If you want to add an image, you should use the ``kernel-figure`` and
476 ``kernel-image`` directives. E.g. to insert a figure with a scalable
479 .. kernel-figure:: svg_image.svg
486 .. kernel-figure:: svg_image.svg
494 * Graphviz: http://www.graphviz.org/content/dot-language
498 .. kernel-figure:: hello.dot
505 .. kernel-figure:: hello.dot
511 ``kernel-render`` directives.::
513 .. kernel-render:: DOT
518 "bar" -> "baz";
523 *literal-block* (:ref:`hello_dot_render`).
527 .. kernel-render:: DOT
532 "bar" -> "baz";
542 .. kernel-render:: SVG
544 :alt: so-nw-arrow
546 <?xml version="1.0" encoding="UTF-8"?>
553 .. kernel-render:: SVG
555 :alt: so-nw-arrow
557 <?xml version="1.0" encoding="UTF-8"?>
560 <line x1="180" y1="370" x2="500" y2="50" stroke="black" stroke-width="15px"/>