Skip to content

Commit

Permalink
Update schema file linking
Browse files Browse the repository at this point in the history
  • Loading branch information
matiasdaloia committed Nov 15, 2024
1 parent 332aa82 commit 98ee01c
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ docs/build
!.devcontainer/*.example.json

!tests/data/*.json
!docs/assets/*.json
!docs/source/_static/*.json
File renamed without changes.
15 changes: 0 additions & 15 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

import os
import shutil

project = "Documentation for scanoss-py"
copyright = "2024, Scan Open Source Solutions SL"
Expand All @@ -22,22 +20,9 @@
exclude_patterns = []


def setup():
if not os.path.exists("_static"):
os.makedirs("_static")

schema_path = os.path.join("..", "asets", "scanoss-settings-schema.json")
if os.path.exists(schema_path):
shutil.copy2(schema_path, "_static/scanoss-settings-schema.json")


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"
html_logo = "scanosslogo.png"
html_static_path = ["_static"]

html_context = {
"schema_url": "https://scanoss.readthedocs.io/en/latest/_static/scanoss-settings-schema.json"
}
2 changes: 1 addition & 1 deletion docs/source/scanoss_settings_schema.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Settings File

SCANOSS provides a settings file to customize the scanning process. The settings file is a JSON file that contains project information and BOM (Bill of Materials) rules. It allows you to include, remove, or replace components in the BOM before and after scanning.

The schema is available at: ``https://<your-project>.readthedocs.io/en/latest/_static/schema.json``
The schema is available to download :download:`here </_static/scanoss-settings-schema.json>`

Schema Overview
---------------
Expand Down

0 comments on commit 98ee01c

Please sign in to comment.