Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update Sphinx and myst-parser versions; resolve warnings #4581

Merged
merged 10 commits into from
Dec 18, 2024
Merged

docs: Update Sphinx and myst-parser versions; resolve warnings #4581

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b160cae
Update Sphinx and myst-parser versions; resolve documentation warnings
giacob500 Nov 21, 2024
aa8c78b
Update spelling excludes file
giacob500 Nov 27, 2024
f1005ea
Merge branch 'intel:main' into update-sphinx-and-myst-parser
giacob500 Nov 27, 2024
de58222
Revert "Update spelling excludes file"
giacob500 Nov 29, 2024
50ca908
Revert "Update Sphinx and myst-parser versions; resolve documentation…
giacob500 Nov 29, 2024
606e7ed
Excluded sbom directory
giacob500 Dec 7, 2024
d8e2065
Reorganised toctree
giacob500 Dec 7, 2024
0dbc40f
Updated requiremenets.txt
giacob500 Dec 7, 2024
a3fa3c6
chore: Delete doc/=4.0.0
terriko Dec 18, 2024
b4c0e03
chore: Delete doc/=8.0.2
terriko Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/actions/spelling/excludes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
^\.github/
^locales/
^sbom/
35 changes: 35 additions & 0 deletions doc/=4.0.0
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Requirement already satisfied: myst-parser in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (3.0.1)
Collecting myst-parser
Using cached myst_parser-4.0.0-py3-none-any.whl.metadata (5.4 kB)
Requirement already satisfied: docutils<0.22,>=0.19 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from myst-parser) (0.21.2)
Requirement already satisfied: jinja2 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from myst-parser) (3.1.4)
Requirement already satisfied: markdown-it-py~=3.0 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from myst-parser) (3.0.0)
Requirement already satisfied: mdit-py-plugins>=0.4.1,~=0.4 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from myst-parser) (0.4.2)
Requirement already satisfied: pyyaml in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from myst-parser) (6.0.2)
Requirement already satisfied: sphinx<9,>=7 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from myst-parser) (8.1.3)
Requirement already satisfied: mdurl~=0.1 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from markdown-it-py~=3.0->myst-parser) (0.1.2)
Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (2.0.0)
Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (2.0.0)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (2.1.0)
Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (1.0.1)
Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (2.0.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (2.0.0)
Requirement already satisfied: Pygments>=2.17 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (2.18.0)
Requirement already satisfied: snowballstemmer>=2.2 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (2.2.0)
Requirement already satisfied: babel>=2.13 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (2.16.0)
Requirement already satisfied: alabaster>=0.7.14 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (0.7.16)
Requirement already satisfied: imagesize>=1.3 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (1.4.1)
Requirement already satisfied: requests>=2.30.0 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (2.32.3)
Requirement already satisfied: packaging>=23.0 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx<9,>=7->myst-parser) (24.2)
Requirement already satisfied: MarkupSafe>=2.0 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from jinja2->myst-parser) (3.0.2)
Requirement already satisfied: charset-normalizer<4,>=2 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from requests>=2.30.0->sphinx<9,>=7->myst-parser) (3.4.0)
Requirement already satisfied: idna<4,>=2.5 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from requests>=2.30.0->sphinx<9,>=7->myst-parser) (3.10)
Requirement already satisfied: urllib3<3,>=1.21.1 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from requests>=2.30.0->sphinx<9,>=7->myst-parser) (2.2.3)
Requirement already satisfied: certifi>=2017.4.17 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from requests>=2.30.0->sphinx<9,>=7->myst-parser) (2024.8.30)
Using cached myst_parser-4.0.0-py3-none-any.whl (84 kB)
Installing collected packages: myst-parser
Attempting uninstall: myst-parser
Found existing installation: myst-parser 3.0.1
Uninstalling myst-parser-3.0.1:
Successfully uninstalled myst-parser-3.0.1
Successfully installed myst-parser-4.0.0
21 changes: 21 additions & 0 deletions doc/=8.0.2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Requirement already satisfied: sphinx in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (8.1.3)
Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (2.0.0)
Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (2.0.0)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (2.1.0)
Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (1.0.1)
Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (2.0.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (2.0.0)
Requirement already satisfied: Jinja2>=3.1 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (3.1.4)
Requirement already satisfied: Pygments>=2.17 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (2.18.0)
Requirement already satisfied: docutils<0.22,>=0.20 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (0.21.2)
Requirement already satisfied: snowballstemmer>=2.2 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (2.2.0)
Requirement already satisfied: babel>=2.13 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (2.16.0)
Requirement already satisfied: alabaster>=0.7.14 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (0.7.16)
Requirement already satisfied: imagesize>=1.3 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (1.4.1)
Requirement already satisfied: requests>=2.30.0 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (2.32.3)
Requirement already satisfied: packaging>=23.0 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from sphinx) (24.2)
Requirement already satisfied: MarkupSafe>=2.0 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from Jinja2>=3.1->sphinx) (3.0.2)
Requirement already satisfied: charset-normalizer<4,>=2 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from requests>=2.30.0->sphinx) (3.4.0)
Requirement already satisfied: idna<4,>=2.5 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from requests>=2.30.0->sphinx) (3.10)
Requirement already satisfied: urllib3<3,>=1.21.1 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from requests>=2.30.0->sphinx) (2.2.3)
Requirement already satisfied: certifi>=2017.4.17 in /home/giacob500/Code/venv3.13/lib/python3.13/site-packages (from requests>=2.30.0->sphinx) (2024.8.30)
3 changes: 2 additions & 1 deletion doc/how_to_guides/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ How To Guides
sbom
sbom_generation
scan_installed_packages

vex_generation
mismatch_cli
0 doc/mismatch_cli.md → doc/how_to_guides/mismatch_cli.md
View file
Open in desktop
File renamed without changes.
3 changes: 2 additions & 1 deletion doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The CVE Binary Tool helps you determine if your system includes known vulnerabil
MANUAL.md
CSV2CVE.md
how_to_guides/index
sboms_for_humans/index
RELEASE.md
CONTRIBUTING.md
CHECKERS.md
Expand All @@ -25,7 +26,7 @@ The CVE Binary Tool helps you determine if your system includes known vulnerabil
triaging_process.md
new-contributor-tips.md
pypi_downloads.md
mismatch_data.md
mismatch_data.md

Indices and tables
==================
Expand Down
4 changes: 2 additions & 2 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Sphinx==7.4.7
Sphinx==8.0.2
sphinx_markdown_tables
myst_parser==3.0.1
myst_parser==4.0.0
sbom2doc
pillow>=10.3.0 # not directly required, pinned by Snyk to avoid a vulnerability
requests>=2.32.2 # not directly required, pinned by Snyk to avoid a vulnerability
Expand Down
7 changes: 7 additions & 0 deletions sbom/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. toctree::
:maxdepth: 2
:caption: Contents:

intro
usage
sbom_for_humans/index
7 changes: 7 additions & 0 deletions sbom/sboms_for_humans/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. toctree::
:maxdepth: 2
:caption: SBOM for Humans

README.md
./sbom/sboms_for_humans/cve-bin-tool-py3.7.json

Loading