linux/Documentation/doc-guide/index.rst

.. _doc_guide:

=================================
How to write kernel documentation
=================================

.. toctree::
   :maxdepth: 1

   sphinx
   kernel-doc
   parse-headers

.. only::  subproject and html

   Indices
   =======

   * :ref:`genindex`
docs-rst: doc-guide: split the kernel-documentation.rst contents Having the kernel-documentation at the topmost level doesn't allow generating a separate PDF file for it. Also, makes harder to add extra contents. So, place it on a sub-dir. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-11-17 08:32:33 -02:00			`.. _doc_guide:`

			`=================================`
			`How to write kernel documentation`
			`=================================`

			`.. toctree::`
			`:maxdepth: 1`

docs: doc-guide: remove the extension from .rst files On almost all places, we're including ReST files without the extension. Let's remove the extension here as well, in order to use just one standard. Suggested-by: Jani Nikula <jani.nikula@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2019-04-19 07:30:51 -03:00			`sphinx`
			`kernel-doc`
			`parse-headers`
docs-rst: doc-guide: split the kernel-documentation.rst contents Having the kernel-documentation at the topmost level doesn't allow generating a separate PDF file for it. Also, makes harder to add extra contents. So, place it on a sub-dir. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-11-17 08:32:33 -02:00
			`.. only:: subproject and html`

			`Indices`
			`=======`

			* :ref:`genindex`