Adding mkdocs_licenseinfo (#7)

djpugh · Dec 27, 2023 · 5122239 · 5122239
1 parent 01bbfc6
commit 5122239
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 0 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -10,6 +10,7 @@ nav:
  - 'Developing':
     - developing/index.md
     - developing/license.md
+    - developing/sbom.md
     - 'Test Coverage': coverage.md
  - 'Issue Tracker': https://github.com/djpugh/mkdocs_github_changelog/issues
  - changelog.md
@@ -60,6 +61,7 @@ plugins:
   - include-markdown
   # https://github.com/mondeja/mkdocs-include-markdown-plugin
   - mkdocs_github_changelog
+  - mkdocs_licenseinfo
 # https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages
 
 extra:

diff --git a/docs/source/developing/sbom.md b/docs/source/developing/sbom.md
@@ -0,0 +1,42 @@
+# Software Bill of Materials
+
+This package is licensed with the [``MIT License``](license.md)
+
+## Runtime Dependencies
+
+These are the dependencies required to run ``mkdocs_github_changelog``:
+
+### ::licenseinfo
+
+## Development Dependencies
+
+These are the dependencies required for developing ``mkdocs_github_changelog``:
+
+### ::licenseinfo
+    using: PEP631:dev
+    diff: PEP631
+
+### Test Dependencies
+#### ::licenseinfo
+    using: PEP631:dev;dev-test
+    diff: PEP631:dev
+
+### Lint Dependencies
+#### ::licenseinfo
+    using: PEP631:dev;dev-lint
+    diff: PEP631:dev
+
+### Security Dependencies
+#### ::licenseinfo
+    using: PEP631:dev;dev-security
+    diff: PEP631:dev
+
+### Docs Dependencies
+#### ::licenseinfo
+    using: PEP631:dev;dev-docs
+    diff: PEP631:dev
+
+### Build Dependencies
+#### ::licenseinfo
+    using: PEP631:dev;dev-build
+    diff: PEP631:dev
diff --git a/pyproject.toml b/pyproject.toml
@@ -84,6 +84,7 @@ dev-docs = [
     "mkdocs-git-authors-plugin",
     "mkdocs-coverage",
     "mkdocs-include-markdown-plugin",
+    "mkdocs-licenseinfo",
     "mike"
 ]
 dev-build = [