linux/Documentation/doc-guide/index.rst

.. _doc_guide:

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

.. toctree::
   :maxdepth: 1

   sphinx.rst
   kernel-doc.rst
   parse-headers.rst
   docbook.rst

.. 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 18:32:33 +08:00			`.. _doc_guide:`

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

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

			`sphinx.rst`
			`kernel-doc.rst`
parse-headers.pl: add documentation for this script Provide a man page for parse-headers.pl, describing how to use it. The documentation on ReST format was generated via pod2rst: http://search.cpan.org/~dowens/Pod-POM-View-Restructured-0.02/bin/pod2rst Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-11-17 18:32:34 +08:00			`parse-headers.rst`
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 18:32:33 +08:00			`docbook.rst`

			`.. only:: subproject and html`

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

			* :ref:`genindex`