Fix index page issues

Signed-off-by: Ayan Sinha Mahapatra <asmahapatra@aboutcode.org>

Author: AyanSinhaMahapatra

docs/_static/theme_overrides.css

@@ -0,0 +1,73 @@
+/* this is the container for the pages */
+.wy-nav-content {
+    max-width: 100%;
+    padding: 0px 40px 0px 0px;
+    margin-top: 0px;
+}
+
+.wy-nav-content-wrap {
+    border-right: solid 1px;
+}
+
+div.rst-content {
+    max-width: 1300px;
+    border: 0;
+    padding: 10px 80px 10px 80px;
+    margin-left: 50px;
+}
+
+@media (max-width: 768px) {
+    div.rst-content {
+        max-width: 1300px;
+        border: 0;
+        padding: 0px 10px 10px 10px;
+        margin-left: 0px;
+    }
+}
+
+.row {
+    clear: both;
+}
+
+.column img {
+    border: 1px solid gray;
+}
+
+@media only screen and (min-width: 1000px),
+only screen and (min-width: 500px) and (max-width: 768px) {
+
+    .column {
+        padding-left: 5px;
+        padding-right: 5px;
+        float: left;
+    }
+
+    .column3 {
+        width: calc(33.3% - 10px);
+    }
+
+    .column2 {
+        width: calc(50% - 11px);
+        position: relative;
+    }
+
+    .column2:before {
+        padding-top: 61.8%;
+        content: "";
+        display: block;
+        float: left;
+    }
+
+    .top-left {
+        border-right: 1px solid var(--color-background-border);
+        border-bottom: 1px solid var(--color-background-border);
+    }
+
+    .top-right {
+        border-bottom: 1px solid var(--color-background-border);
+    }
+
+    .bottom-left {
+        border-right: 1px solid var(--color-background-border);
+    }
+}

docs/conf.py

@@ -65,6 +65,20 @@
 
 # -- Options for HTML output -------------------------------------------------
 
+html_static_path = ["_static"]
+
+html_context = {
+    "display_github": True,
+    "github_user": "aboutcode-org",
+    "github_repo": "scancode.io",
+    "github_version": "main",  # branch
+    "conf_py_path": "/docs/",  # path in the checkout to the docs root
+}
+
+html_css_files = [
+    "theme_overrides.css",
+]
+
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = "sphinx_rtd_theme"

docs/improve-docs.rst

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

docs/index.rst

@@ -21,28 +21,26 @@ to help you know where to look for certain things.
 
 .. rst-class:: column column2 top-left
 
-:ref:`getting-started`
+Getting started
 ~~~~~~~~~~~~~~~~~~~~~~
 
 Start here if you are new to ScanCode.
 
 - :ref:`quickstart`
-
- - :ref:`introduction`
- - :ref:`installation`
- - :ref:`user-interface`
-
-- :ref:`faq`
+- :ref:`introduction`
+- :ref:`installation`
+- :ref:`contributing`
+- :ref:`user_interface`
 
 .. rst-class:: column column2 top-right
 
-:ref:`tutorials`
+Tutorials
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Learn via practical step-by-step guides.
 
 - :ref:`tutorial_web_ui_analyze_docker_image`
-- :ref:`tutorial_web_ui_review_scan_result`
+- :ref:`tutorial_web_ui_review_scan_results`
 - :ref:`tutorial_cli_analyze_docker_image`
 - :ref:`tutorial_api_analyze_package_archive`
 - :ref:`tutorial_license_policies`
@@ -52,57 +50,84 @@ Learn via practical step-by-step guides.
 
 .. rst-class:: column column2 bottom-left
 
-:ref:`how-to-guides`
-~~~~~~~~~~~~~~~~~~~~
+Reference Docs
+~~~~~~~~~~~~~~~~~~
 
-Helps you accomplish things.
+Reference documentation for scancode features and customizations.
 
-- :ref:`contributing`
+- :ref:`built_in_pipelines`
+- :ref:`custom_pipelines`
+- :ref:`project_configuration`
+- :ref:`inputs`
+- :ref:`output_files`
+- :ref:`command_line_interface`
+- :ref:`rest_api`
+- :ref:`policies`
+- :ref:`data_model`
+- :ref:`automation`
+- :ref:`webhooks`
+- :ref:`scancodeio_settings`
+- :ref:`recognized_distros_os_images`
 
 .. rst-class:: column column2 bottom-right
 
-:ref:`reference` and :ref:`explanation`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Explanations
+~~~~~~~~~~~~~~~~~~
 
 Consult the reference to understand ScanCode.io concepts.
 
-- :ref:`scanpipe-concepts`
-- :ref:`built-in-pipelines`
-- :ref:`custom-pipelines`
-- :ref:`scanpipe-pipes`
-- :ref:`project-configuration`
-- :ref:`inputs`
-- :ref:`output-files`
-- :ref:`command-line-interface`
-- :ref:`rest-api`
-- :ref:`policies`
-- :ref:`data-models`
-- :ref:`automation`
-- :ref:`webhooks`
-- :ref:`application-settings`
-- :ref:`distros-os-images`
+- :ref:`scanpipe_concepts`
+- :ref:`scanpipe_pipes`
 
 .. rst-class:: row clearfix
 
-Improving Documentation
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. include::  /rst-snippets/improve-docs.rst
+Misc
+~~~~~~~~~~~~~~~
 
-.. toctree::
-   :maxdepth: 2
-   :hidden:
+- :ref:`faq`
+- :ref:`changelog`
 
-   getting-started/index
-   tutorials/index
-   how-to-guides/index
-   reference/index
-   explanation/index
+.. include:: improve-docs.rst
 
-   changelog
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`search`
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    quickstart
+    introduction
+    installation
+    user-interface
+    faq
+    contributing
+    changelog
+    tutorial_web_ui_analyze_docker_image
+    tutorial_web_ui_review_scan_results
+    tutorial_cli_analyze_docker_image
+    tutorial_cli_analyze_codebase
+    tutorial_api_analyze_package_archive
+    tutorial_license_policies
+    tutorial_vulnerablecode_integration
+    tutorial_web_ui_symbol_and_string_collection
+    tutorial_cli_end_to_end_scanning_to_dejacode
+    scanpipe-concepts
+    built-in-pipelines
+    custom-pipelines
+    scanpipe-pipes
+    project-configuration
+    inputs
+    output-files
+    command-line-interface
+    rest-api
+    policies
+    data-models
+    automation
+    webhooks
+    application-settings
+    distros-os-images