Skip to content

Commit cd59436

Browse files
Add root index for documentation
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 281a747 commit cd59436

1 file changed

Lines changed: 39 additions & 3 deletions

File tree

docs/source/index.rst

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,64 @@ Guide
77
.. toctree::
88
:maxdepth: 2
99

10+
getting-started/index
11+
cli-reference/index
12+
plugins/index
13+
tutorials/index
14+
how-to-guides/index
15+
explanations/index
16+
contribute/index
17+
misc/index
1018
license
1119

20+
Getting Started
21+
***************
22+
23+
.. toctree::
24+
:maxdepth: 2
25+
26+
scancode-toolkit/getting-started/newcomer
1227

1328
Tutorial Documents
1429
==================
1530

1631
Tutorial documents provide specific instructions to help you get started.
1732

33+
.. toctree::
34+
:maxdepth: 2
35+
36+
scancode-toolkit/tutorials/index
1837

1938
How-To Documents
2039
================
2140

2241
How-To documents explain how to accomplish specific tasks.
2342

43+
.. toctree::
44+
:maxdepth: 2
45+
46+
scancode-toolkit/how-to-guides/index
2447

2548
Reference Documents
2649
===================
2750

28-
Reference documents describe application concepts in depth.
51+
Reference documents describe the Command Line options, and application concepts in depth.
2952

53+
.. toctree::
54+
:maxdepth: 2
55+
56+
scancode-toolkit/cli-reference/index
3057

3158
Discussion Documents
3259
====================
3360

34-
Discussion documents provide insights into integration of the application into your own software
35-
development life cycle.
61+
Discussion documents provide insights into how scancode works, and integration of the application
62+
into your own software development life cycle.
63+
64+
.. toctree::
65+
:maxdepth: 2
66+
67+
scancode-toolkit/explanations/index
3668

3769

3870
Indices and Tables
@@ -41,3 +73,7 @@ Indices and Tables
4173
* :ref:`genindex`
4274
* :ref:`modindex`
4375
* :ref:`search`
76+
77+
.. _improve_docs:
78+
79+
.. include:: /scancode-toolkit/rst_snippets/improve_docs.rst

0 commit comments

Comments
 (0)