Lines Matching full:documentation

6 The Linux kernel uses `Sphinx`_ to generate pretty documentation from
7 `reStructuredText`_ files under ``Documentation``. To build the documentation in
9 documentation is placed in ``Documentation/output``.
15 documentation comments, or kernel-doc comments, from source files. Usually these
20 Finally, there are thousands of plain text documentation files scattered around
21 ``Documentation``. Some of these will likely be converted to reStructuredText
29 The ReST markups currently used by the Documentation/ files are meant to be
37 on your machine would cause the documentation build to break.
62        (sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt
67 the virtual environment before building the documentation.
72 The kernel documentation build system contains an extension that
78 still build the documentation, but won't include any images at the
109 		pip install -r Documentation/sphinx/requirements.txt
130 The usual way to generate the documentation is to run ``make htmldocs`` or
131 ``make pdfdocs``. There are also other formats available, see the documentation
132 section of ``make help``. The generated documentation is placed in
133 format-specific subdirectories under ``Documentation/output``.
135 To generate documentation, Sphinx (``sphinx-build``) must obviously be
145 To remove the generated documentation, run ``make cleandocs``.
147 Writing Documentation
150 Adding new documentation can be as simple as:
152 1. Add a new ``.rst`` file somewhere under ``Documentation``.
153 2. Refer to it from the Sphinx main `TOC tree`_ in ``Documentation/index.rst``.
157 This is usually good enough for simple documentation (like the one you're
160 documentation is under ``Documentation/gpu``, split to several ``.rst`` files,
164 See the documentation for `Sphinx`_ and `reStructuredText`_ on what you can do
172 Specific guidelines for the kernel documentation
175 Here are some specific guidelines for the kernel documentation:
178   simple. For the most part the documentation should be plain text with
183   documentation to reStructuredText.
186   documentation.
226 The **Sphinx C Domain** (name c) is suited for documentation of C API. E.g. a
247 references to function documentation.  Due to some Sphinx extension magic,
248 the documentation build system will automatically turn a reference to
343 Cross-referencing from one documentation page to another can be done by passing
344 the path to the file starting from the Documentation folder.
347     See Documentation/doc-guide/sphinx.rst.
355 Documentation/doc-guide/kernel-doc.rst.