diff mbox series

[2/5] doc: simplify the toctree

Message ID 20200809141731.32433-3-luc.vanoostenryck@gmail.com (mailing list archive)
State Mainlined, archived
Headers show
Series improve presenttation of the documentation | expand

Commit Message

Luc Van Oostenryck Aug. 9, 2020, 2:17 p.m. UTC 
Combine the 'user' documentation with the one for developers
and add captions for each sections in order to have this
structuration visible in the sidebar.

Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
---
 Documentation/index.rst | 28 +++++++---------------------
 1 file changed, 7 insertions(+), 21 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/index.rst b/Documentation/index.rst
index cbe0521b7091..e8e40c0cd109 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -63,42 +63,28 @@  To subscribe to the list, send an email with
 Bugs can also be reported and tracked via the Linux kernel's bugzilla:
 http://bugzilla.kernel.org/enter_bug.cgi?component=Sparse&product=Tools.
 
-User documentation
-------------------
-.. toctree::
-   :maxdepth: 1
-
-   annotations
 
-Developer documentation
------------------------
 .. toctree::
+   :caption: Documentation
    :maxdepth: 1
 
-   test-suite
+   annotations
    dev-options
+   types
    api
    IR
-   types
+   test-suite
+   doc-guide
 
-How to contribute
------------------
 .. toctree::
+   :caption: How to contribute
    :maxdepth: 1
 
    submitting-patches
    TODO
 
-Documentation
--------------
-.. toctree::
-   :maxdepth: 1
-
-   doc-guide
-
-Release Notes
--------------
 .. toctree::
+   :caption: Release Notes
    :maxdepth: 1
 
    release-notes/index