From 72c23c8f5e8a157943302da5c8f2ebba480c1f07 Mon Sep 17 00:00:00 2001 From: David J Pugh <6003255+djpugh@users.noreply.github.com> Date: Wed, 27 Dec 2023 12:18:29 +0000 Subject: [PATCH] Adding docs plugins (#25) * adding docs plugins * Adding plugins and fixing order --- docs/mkdocs.yml | 8 ++- docs/source/changelog.md | 3 + docs/source/developing/sbom.md | 56 +++++++++++++++++++ pyproject.toml | 2 + .../ingredients/pyproject.toml.template | 2 +- 5 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 docs/source/changelog.md create mode 100644 docs/source/developing/sbom.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1be2119..460b35a 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -9,14 +9,16 @@ nav: - 'Developing': - developing/index.md - developing/license.md + - developing/sbom.md - 'Test Coverage': coverage.md - 'API': - 'nskit.common': api/nskit.common.md - 'nskit.mixer': api/nskit.mixer.md - 'nskit.recipes': api/nskit.recipes.md - 'nskit.vcs': api/nskit.vcs.md + - changelog.md - 'Issue Tracker': https://github.com/djpugh/nskit/issues - - 'Changelog': https://github.com/djpugh/nskit/releases + exclude_docs: | mkdocs.yml theme: @@ -66,7 +68,9 @@ plugins: type: iso_date - include-markdown # https://github.com/mondeja/mkdocs-include-markdown-plugin - + - mkdocs_github_changelog: + match: '[0-9+].[0-9+].[0-9]+' + - mkdocs_licenseinfo # https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages extra: diff --git a/docs/source/changelog.md b/docs/source/changelog.md new file mode 100644 index 0000000..cbff7e2 --- /dev/null +++ b/docs/source/changelog.md @@ -0,0 +1,3 @@ +# Releases + +## ::github-release-changelog djpugh/nskit diff --git a/docs/source/developing/sbom.md b/docs/source/developing/sbom.md new file mode 100644 index 0000000..d1ff9fd --- /dev/null +++ b/docs/source/developing/sbom.md @@ -0,0 +1,56 @@ +# Software Bill of Materials + +``nskit`` is licensed under the [MIT License](license.md). + +The dependencies for ``nskit`` are: + +## Runtime Dependencies + +These are the dependencies used for running ``nskit``: + +### ::licenseinfo + +### Extras: + +#### Github +##### ::licenseinfo + using: PEP631:github + diff: PEP631 + +#### Azure Devops +##### ::licenseinfo + using: PEP631:azure_devops + diff: PEP631 + +## Development Dependencies + +These are dependencies used for development (e.g. testing, linting etc.) of ``nskit``: + +### ::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 index 5b1874b..254ccd9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -97,6 +97,8 @@ dev-docs = [ "mkdocs-git-authors-plugin", "mkdocs-coverage", "mkdocs-include-markdown-plugin", + 'mkdocs-github-changelog', + 'mkdocs-licenseinfo', # "mkdocs-gen-files", # "mkdocs-literate-nav", "mike" diff --git a/src/nskit/recipes/python/ingredients/pyproject.toml.template b/src/nskit/recipes/python/ingredients/pyproject.toml.template index b4623f1..6cbd8a9 100644 --- a/src/nskit/recipes/python/ingredients/pyproject.toml.template +++ b/src/nskit/recipes/python/ingredients/pyproject.toml.template @@ -185,7 +185,7 @@ known_first_party = [ "{{repo.py_root}}.*" ] -known_application = '{{repo.py_name}}.*' +known_application = '{{repo.py_name}}*' force_alphabetical_sort_within_sections = true force_sort_within_sections = true reverse_relative = true \ No newline at end of file