diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-11-17 08:32:33 -0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-11-19 10:22:04 -0700 |
| commit | 1dc4bbf0b268246f6202c761016735933b6f0b99 (patch) | |
| tree | 0bb12a6c59472d8167dbebac4fe6a68023956813 /Documentation/doc-guide/index.rst | |
| parent | 726d661fea3e3f76d36515c74e4ce58e7789418e (diff) | |
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>
Diffstat (limited to 'Documentation/doc-guide/index.rst')
| -rw-r--r-- | Documentation/doc-guide/index.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/doc-guide/index.rst b/Documentation/doc-guide/index.rst new file mode 100644 index 000000000000..695b7b6cf6ed --- /dev/null +++ b/Documentation/doc-guide/index.rst @@ -0,0 +1,19 @@ +.. _doc_guide: + +================================= +How to write kernel documentation +================================= + +.. toctree:: + :maxdepth: 1 + + sphinx.rst + kernel-doc.rst + docbook.rst + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` |