summaryrefslogtreecommitdiffstats
path: root/Documentation/doc-guide/index.rst
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2016-11-19 18:28:58 +0100
committerJonathan Corbet <corbet@lwn.net>2016-11-19 18:28:58 +0100
commitca9667fcc855676aa5c35978f201034d38790829 (patch)
treef52523e399b6938fd79b0b0c25b3c55e27600e55 /Documentation/doc-guide/index.rst
parentdoc: Document the new inline struct member kernel-doc style (diff)
parentparse-headers.rst: add an introduction to the man page (diff)
downloadlinux-ca9667fcc855676aa5c35978f201034d38790829.tar.xz
linux-ca9667fcc855676aa5c35978f201034d38790829.zip
Merge branch 'mauro-doc' into docs-next
Diffstat (limited to 'Documentation/doc-guide/index.rst')
-rw-r--r--Documentation/doc-guide/index.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/Documentation/doc-guide/index.rst b/Documentation/doc-guide/index.rst
new file mode 100644
index 000000000000..6fff4024606e
--- /dev/null
+++ b/Documentation/doc-guide/index.rst
@@ -0,0 +1,20 @@
+.. _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`