Skip to content

Commit d9ca04b

Browse files
AyanSinhaMahapatraAyanSinhaMahapatra
committed
Restructuring Scancode-Toolkit Documentation According to 4 functions Rule
This commit completely changes the documentation structure, dividing it into sub-folder adhering to the 4 functions - tutorials, how-to guides, referance and explanation. Also adds the Getting Started, Contributing and Miscellaneous sections. This commit contains only the index.rst files, and later commits will add modular changes in this restructuring. This is very close to the structure that will remain at last, but a lot of content will be added subsequently in the files, and different branches for different versions. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 728226c commit d9ca04b

9 files changed

Lines changed: 136 additions & 33 deletions

File tree

‎docs/source/index.rst‎

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,67 @@
11
AboutCode Documentation
22
=======================
33

4-
Guide
5-
*****
4+
Aboutcode Projects
5+
******************
66

77
.. toctree::
8-
:maxdepth: 2
8+
:maxdepth: 1
99

1010
scancode-toolkit/index
1111
scancode-workbench/index
12-
aboutcode-data/abcd
13-
aboutcode-docs/home
1412
deltacode/index
13+
aboutcode-docs/home
1514
aboutcode-toolkit/index
16-
license
15+
aboutcode-data/abcd
16+
17+
Documentation Guide
18+
*******************
19+
20+
.. toctree::
21+
:maxdepth: 2
22+
1723
help
24+
license
1825
doc_maintenance
1926

2027

2128
Tutorial Documents
22-
==================
29+
******************
2330

24-
Tutorial documents provide specific instructions to help you get started.
31+
.. toctree::
32+
:maxdepth: 2
33+
34+
scancode-toolkit/tutorials/index
2535

2636

2737
How-To Documents
28-
================
38+
****************
2939

30-
How-To documents explain how to accomplish specific tasks.
40+
.. toctree::
41+
:maxdepth: 2
42+
43+
scancode-toolkit/how-to-guides/index
3144

3245

3346
Reference Documents
34-
===================
47+
*******************
3548

36-
Reference documents describe application concepts in depth.
49+
.. toctree::
50+
:maxdepth: 2
51+
52+
scancode-toolkit/cli-reference/index
3753

3854

3955
Discussion Documents
40-
====================
41-
42-
Discussion documents provide insights into integration of the application into your own software development life cycle.
56+
********************
4357

58+
.. toctree::
59+
:maxdepth: 2
60+
61+
scancode-toolkit/explanations/index
4462

4563
Indices and Tables
46-
==================
64+
******************
4765

4866
* :ref:`genindex`
4967
* :ref:`modindex`
50-
* :ref:`search`

‎docs/source/scancode-toolkit/cli-reference/index.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
**Command Line Interface Referance**
2+
====================================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
synopsis
8+
help-text-options
9+
list-options
10+
simple-examples
11+
12+
..
13+
14+
[ToAdd]
15+
core-options
16+
output-format
17+
output-filters-and-control
18+
scan-options-pre
19+
scan-options-post

‎docs/source/scancode-toolkit/contribute/index.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
**Contribute**
2+
==============
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
contrib_dev
8+
cut_new_release
9+
contrib_doc
10+
roadmap
11+
gsoc_17_final_report
12+

‎docs/source/scancode-toolkit/explanations/index.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**How it all Works**
2+
====================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
overview
8+
9+
..
10+
11+
[ToAdd]
12+
file_collect_classify
13+
extract
14+
rules_engine
15+
parser
16+
package
17+
report
18+
integration
19+
20+
..
21+
22+
[ToDo]
23+
Each Section to Be Elaborated

‎docs/source/scancode-toolkit/getting-started/index.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
**Getting Started**
2+
===================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
home
8+
install
9+
ide-config
10+
docs
11+
whats-new
12+
13+
..
14+
15+
[ToAdd]
16+
releases
17+
Link to Changelog

‎docs/source/scancode-toolkit/how-to-guides/index.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
**"How To" Guides**
2+
===================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
add_new_license
8+
add_new_license_detection_rule
9+

‎docs/source/scancode-toolkit/index.rst‎

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,10 @@
44
.. toctree::
55
:maxdepth: 2
66

7-
home
8-
comprehensive_installation
9-
developement
10-
documentation
11-
faq
12-
ide_configaration
13-
licence_policy_plugin
14-
roadmap
15-
support
16-
runtime_performance_reports
17-
plugin_architecture
18-
gsoc_17_final_report
19-
how_to/index
7+
getting-started/index
8+
cli-reference/index
9+
tutorials/index
10+
how-to-guides/index
11+
explanations/index
12+
contribute/index
13+
misc/index

‎docs/source/scancode-toolkit/misc/index.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
**Miscellaneous**
2+
=================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
faq
8+
help
9+
support
10+
perf_report
11+
plugin_arch
12+
licence_policy_plugin
13+

docs/source/scancode-toolkit/how_to/index.rst renamed to docs/source/scancode-toolkit/tutorials/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
**How To :**
2-
=============
1+
**Basic Tutorials**
2+
===================
33

44
.. toctree::
55
:maxdepth: 2
66

7-
how_to_add_new_license_rules_for_enhanced_detection
87
how_to_extract_archives
98
how_to_format_scan_output
109
how_to_run_a_scan

0 commit comments

Comments
 (0)