docs: integrate human readable sbom data (intel#2893)

* fixes: intel#2850

this commit adds a build process for SBOM markdown files triggered by
the docs build process.

Author: jarebear6expepjozn6rakjq5iczi3irqwphcvb

doc/Makefile

@@ -20,4 +20,6 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 docs:
+	# build human readable sboms first 
+	$(MAKE) -C ../sbom
 	$(SPHINXBUILD) $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)

doc/index.rst

@@ -19,6 +19,7 @@ The CVE Binary Tool helps you determine if your system includes known vulnerabil
    RELEASE.md
    CONTRIBUTING.md
    CHECKERS.md
+   sboms_for_humans/README.md
 
 Indices and tables
 ==================

doc/requirements.csv

@@ -2,3 +2,4 @@ vendor,product
 sphinx-doc_not_in_db,Sphinx
 ryanfox_not_in_db,sphinx_markdown_tables
 executablebooks_not_in_db,myst_parser
+anthonyharrison_not_in_db,sbom2doc

doc/requirements.txt

@@ -1,3 +1,4 @@
 Sphinx==4.4.0
 sphinx_markdown_tables
 myst_parser
+sbom2doc

doc/sboms_for_humans

@@ -0,0 +1 @@
+../sbom/sboms_for_humans/

sbom/Makefile

@@ -0,0 +1,6 @@
+.PHONY: all
+
+SBOMS != ls *.spdx
+
+all: $(SBOMS)
+	$(foreach file, $(SBOMS), sbom2doc --input-file $(file) --format markdown --output-file "sboms_for_humans/$(basename $(file)).md"; echo "- [$(basename $(file))]($(basename $(file)).md)" >> sboms_for_humans/README.md;)

sbom/sboms_for_humans/README.md

@@ -0,0 +1,13 @@
+
+# SBOMs For Humans
+
+Made possible with [sbom2doc](https://github.com/anthonyharrison/sbom2doc)
+
+These files are automatically generated as part of the `docs/` build process for [cve-bin-tool.readthedocs.io](https://cve-bin-tool.readthedocs.io)
+
+To manually build human readable files:
+- install `docs/requirements.txt`
+- navigate to the `sbom/` directory in your terminal and run `make`
+
+Generated human readable SBOMs:
+