Skip to content

Commit d457487

Browse files
pombredannepombredanne
authored
Merge pull request #2028 from aboutcode-org/restructure-rtd-index
Restructure documentation index
2 parents df61c28 + 004075e commit d457487

4 files changed

Lines changed: 188 additions & 25 deletions

File tree

‎docs/_static/theme_overrides.css‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
/* this is the container for the pages */
2+
.wy-nav-content {
3+
max-width: 100%;
4+
padding: 0px 40px 0px 0px;
5+
margin-top: 0px;
6+
}
7+
8+
.wy-nav-content-wrap {
9+
border-right: solid 1px;
10+
}
11+
12+
div.rst-content {
13+
max-width: 1300px;
14+
border: 0;
15+
padding: 10px 80px 10px 80px;
16+
margin-left: 50px;
17+
}
18+
19+
@media (max-width: 768px) {
20+
div.rst-content {
21+
max-width: 1300px;
22+
border: 0;
23+
padding: 0px 10px 10px 10px;
24+
margin-left: 0px;
25+
}
26+
}
27+
28+
.row {
29+
clear: both;
30+
}
31+
32+
.column img {
33+
border: 1px solid gray;
34+
}
35+
36+
@media only screen and (min-width: 1000px),
37+
only screen and (min-width: 500px) and (max-width: 768px) {
38+
39+
.column {
40+
padding-left: 5px;
41+
padding-right: 5px;
42+
float: left;
43+
}
44+
45+
.column3 {
46+
width: calc(33.3% - 10px);
47+
}
48+
49+
.column2 {
50+
width: calc(50% - 11px);
51+
position: relative;
52+
}
53+
54+
.column2:before {
55+
padding-top: 61.8%;
56+
content: "";
57+
display: block;
58+
float: left;
59+
}
60+
61+
.top-left {
62+
border-right: 1px solid var(--color-background-border);
63+
border-bottom: 1px solid var(--color-background-border);
64+
}
65+
66+
.top-right {
67+
border-bottom: 1px solid var(--color-background-border);
68+
}
69+
70+
.bottom-left {
71+
border-right: 1px solid var(--color-background-border);
72+
}
73+
}

‎docs/conf.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,20 @@
6565

6666
# -- Options for HTML output -------------------------------------------------
6767

68+
html_static_path = ["_static"]
69+
70+
html_context = {
71+
"display_github": True,
72+
"github_user": "aboutcode-org",
73+
"github_repo": "scancode.io",
74+
"github_version": "main", # branch
75+
"conf_py_path": "/docs/", # path in the checkout to the docs root
76+
}
77+
78+
html_css_files = [
79+
"theme_overrides.css",
80+
]
81+
6882
# The theme to use for HTML and HTML Help pages. See the documentation for
6983
# a list of builtin themes.
7084
html_theme = "sphinx_rtd_theme"

‎docs/improve-docs.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Something Missing?
2+
------------------
3+
4+
If something is missing in the documentation or if you found some part confusing, please file
5+
an `issue <https://github.com/aboutcode-org/scancode.io/issues/new>`_ with your suggestions for
6+
improvement. Use the ``documentation`` issue label.
7+
8+
Your help makes ScanCode docs better, we love hearing from you!

‎docs/index.rst‎

Lines changed: 93 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,104 @@
11
ScanCode.io Documentation
22
=========================
33

4-
Welcome! This is your starting point for everything ScanCode.io.
4+
ScanCode.io provides a Web UI and API to run and review complex scans in rich scripted
5+
pipelines, on different kinds of containers, docker images, package archives, manifests
6+
etc, to get information on licenses, copyrights, sources, and vulnerabilities.
57

6-
In this documentation, you’ll find:
8+
ScanCode.io provides an easy-to-use front-end to ScanCode Toolkit and other AboutCode
9+
projects.The flexible pipeline technology supports advanced scanning tasks such as
10+
container scanning and deploy-to-develop analysis. You can run ScanCode.io in a Docker
11+
container or install it on a Linux server. It provides full support for generating and
12+
consuming CycloneDX and SPDX SBOMs.
713

8-
- A **QuickStart guide** to run your first scan
9-
- An **overview** of what ScanCode.io is and what it can do
10-
- **Installation instructions** for full access
11-
- Step-by-step **tutorials** to dive deeper
12-
- In-depth **reference docs** on concepts, pipelines, configuration, and APIs
13-
- Guides on how to **contribute** to the project and community
14+
Documentation overview
15+
~~~~~~~~~~~~~~~~~~~~~~
16+
17+
The overview below outlines how the documentation is structured
18+
to help you know where to look for certain things.
19+
20+
.. rst-class:: clearfix row
21+
22+
.. rst-class:: column column2 top-left
23+
24+
Getting started
25+
~~~~~~~~~~~~~~~~~~~~~~
26+
27+
Start here if you are new to ScanCode.
28+
29+
- :ref:`quickstart`
30+
- :ref:`introduction`
31+
- :ref:`installation`
32+
- :ref:`contributing`
33+
- :ref:`user_interface`
34+
35+
.. rst-class:: column column2 top-right
36+
37+
Tutorials
38+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39+
40+
Learn via practical step-by-step guides.
41+
42+
- :ref:`tutorial_web_ui_analyze_docker_image`
43+
- :ref:`tutorial_web_ui_review_scan_results`
44+
- :ref:`tutorial_cli_analyze_docker_image`
45+
- :ref:`tutorial_api_analyze_package_archive`
46+
- :ref:`tutorial_license_policies`
47+
- :ref:`tutorial_vulnerablecode_integration`
48+
- :ref:`tutorial_web_ui_symbol_and_string_collection`
49+
- :ref:`tutorial_cli_end_to_end_scanning_to_dejacode`
50+
51+
.. rst-class:: column column2 bottom-left
52+
53+
Reference Docs
54+
~~~~~~~~~~~~~~~~~~
55+
56+
Reference documentation for scancode features and customizations.
57+
58+
- :ref:`built_in_pipelines`
59+
- :ref:`custom_pipelines`
60+
- :ref:`project_configuration`
61+
- :ref:`inputs`
62+
- :ref:`output_files`
63+
- :ref:`command_line_interface`
64+
- :ref:`rest_api`
65+
- :ref:`policies`
66+
- :ref:`data_model`
67+
- :ref:`automation`
68+
- :ref:`webhooks`
69+
- :ref:`scancodeio_settings`
70+
- :ref:`recognized_distros_os_images`
71+
72+
.. rst-class:: column column2 bottom-right
73+
74+
Explanations
75+
~~~~~~~~~~~~~~~~~~
76+
77+
Consult the reference to understand ScanCode.io concepts.
78+
79+
- :ref:`scanpipe_concepts`
80+
- :ref:`scanpipe_pipes`
81+
82+
.. rst-class:: row clearfix
83+
84+
Misc
85+
~~~~~~~~~~~~~~~
86+
87+
- :ref:`faq`
88+
- :ref:`changelog`
89+
90+
.. include:: improve-docs.rst
91+
92+
93+
Indices and tables
94+
==================
95+
96+
* :ref:`genindex`
97+
* :ref:`search`
1498

1599
.. toctree::
16100
:maxdepth: 2
17-
:caption: Getting Started
101+
:hidden:
18102

19103
quickstart
20104
introduction
@@ -23,11 +107,6 @@ In this documentation, you’ll find:
23107
faq
24108
contributing
25109
changelog
26-
27-
.. toctree::
28-
:maxdepth: 2
29-
:caption: Tutorials
30-
31110
tutorial_web_ui_analyze_docker_image
32111
tutorial_web_ui_review_scan_results
33112
tutorial_cli_analyze_docker_image
@@ -37,11 +116,6 @@ In this documentation, you’ll find:
37116
tutorial_vulnerablecode_integration
38117
tutorial_web_ui_symbol_and_string_collection
39118
tutorial_cli_end_to_end_scanning_to_dejacode
40-
41-
.. toctree::
42-
:maxdepth: 2
43-
:caption: Reference
44-
45119
scanpipe-concepts
46120
built-in-pipelines
47121
custom-pipelines
@@ -57,9 +131,3 @@ In this documentation, you’ll find:
57131
webhooks
58132
application-settings
59133
distros-os-images
60-
61-
Indices and tables
62-
==================
63-
64-
* :ref:`genindex`
65-
* :ref:`search`

0 commit comments

Comments
 (0)