Lines Matching full:documentation

4 The Linux kernel uses `Sphinx`_ to generate pretty documentation from
5 `reStructuredText`_ files under ``Documentation``. To build the documentation in
7 documentation is placed in ``Documentation/output``.
13 documentation comments, or kernel-doc comments, from source files. Usually these
18 Finally, there are thousands of plain text documentation files scattered around
19 ``Documentation``. Some of these will likely be converted to reStructuredText
27 The ReST markups currently used by the Documentation/ files are meant to be
36 on your machine would cause the documentation build to break.
61        (sphinx_1.4) $ pip install -r Documentation/sphinx/requirements.txt
66 the virtual environment before building the documentation.
71 The kernel documentation build system contains an extension that
77 still build the documentation, but won't include any images at the
108 		pip install -r Documentation/sphinx/requirements.txt
129 The usual way to generate the documentation is to run ``make htmldocs`` or
130 ``make pdfdocs``. There are also other formats available, see the documentation
131 section of ``make help``. The generated documentation is placed in
132 format-specific subdirectories under ``Documentation/output``.
134 To generate documentation, Sphinx (``sphinx-build``) must obviously be
144 To remove the generated documentation, run ``make cleandocs``.
146 Writing Documentation
149 Adding new documentation can be as simple as:
151 1. Add a new ``.rst`` file somewhere under ``Documentation``.
152 2. Refer to it from the Sphinx main `TOC tree`_ in ``Documentation/index.rst``.
156 This is usually good enough for simple documentation (like the one you're
159 documentation is under ``Documentation/gpu``, split to several ``.rst`` files,
163 See the documentation for `Sphinx`_ and `reStructuredText`_ on what you can do
171 Specific guidelines for the kernel documentation
174 Here are some specific guidelines for the kernel documentation:
177   simple. For the most part the documentation should be plain text with
182   documentation to reStructuredText.
185   documentation.
225 The **Sphinx C Domain** (name c) is suited for documentation of C API. E.g. a