diff options
| author | Luc Van Oostenryck <luc.vanoostenryck@gmail.com> | 2020-08-01 03:18:27 +0200 |
|---|---|---|
| committer | Luc Van Oostenryck <luc.vanoostenryck@gmail.com> | 2020-08-03 00:15:14 +0200 |
| commit | b09b9dda368dcc8640f9dff2129e8b651872edf4 (patch) | |
| tree | 902149193a13fe9d389dd1e8f4102aceb6304b7c | |
| parent | 9cc01abd43e3950a7c4da2b01a8851fd48dfa3b0 (diff) | |
| download | sparse-b09b9dda368dcc8640f9dff2129e8b651872edf4.tar.gz | |
doc: simplify the toctree
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>
| -rw-r--r-- | Documentation/index.rst | 28 |
1 files changed, 7 insertions, 21 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst index cbe0521b..e8e40c0c 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 |