From 26541d6b40a4aad45355f04ee3f6ff13107233f4 Mon Sep 17 00:00:00 2001 From: Jesper Friis Date: Fri, 16 Aug 2024 17:19:58 +0200 Subject: [PATCH 1/3] Updated documentation navigation. --- README.md | 10 +++++----- docs/index.md | 10 +++++----- mkdocs.yml | 4 +++- 3 files changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 17aee331..61e9828f 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ Getting started * [Tutorial] * [Discovery of custom backends] * [Reference manual] -* [Known issues] Basic concepts @@ -85,7 +84,7 @@ pip install rdflib pint License and copyright --------------------- -All files in this repository are licensed under the [MIT license](LICENSE). +All files in this repository are licensed under the [MIT license]. If not stated otherwise in the top of the files, they have copyright © 2022 SINTEF. @@ -104,10 +103,11 @@ We gratefully acknowledge the following projects for supporting the development -[Tutorial]: docs/tutorial.md -[Discovery of custom backends]: docs/backend_discovery.md +[Tutorial]: https://emmc-asbl.github.io/tripper/latest/tutorial/ +[Discovery of custom backends]: https://emmc-asbl.github.io/tripper/latest/backend_discovery/ [Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/ -[Known issues]: https://emmc-asbl.github.io/tripper/latest/known-issues.md +[Known issues]: https://emmc-asbl.github.io/tripper/latest/known-issues/ +[MIT license]: https://emmc-asbl.github.io/tripper/latest/LICENSE/ [tripper]: https://emmc-asbl.github.io/tripper [rdflib]: https://rdflib.readthedocs.io/en/stable/ [PyPI]: https://pypi.org/project/tripper diff --git a/docs/index.md b/docs/index.md index 3b0f5718..61e9828f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,7 +14,6 @@ Getting started * [Tutorial] * [Discovery of custom backends] * [Reference manual] -* [Known issues] Basic concepts @@ -85,7 +84,7 @@ pip install rdflib pint License and copyright --------------------- -All files in this repository are licensed under the [MIT license](LICENSE.md). +All files in this repository are licensed under the [MIT license]. If not stated otherwise in the top of the files, they have copyright © 2022 SINTEF. @@ -104,10 +103,11 @@ We gratefully acknowledge the following projects for supporting the development -[Tutorial]: tutorial.md -[Discovery of custom backends]: backend_discovery.md +[Tutorial]: https://emmc-asbl.github.io/tripper/latest/tutorial/ +[Discovery of custom backends]: https://emmc-asbl.github.io/tripper/latest/backend_discovery/ [Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/ -[Known issues]: https://emmc-asbl.github.io/tripper/latest/known-issues.md +[Known issues]: https://emmc-asbl.github.io/tripper/latest/known-issues/ +[MIT license]: https://emmc-asbl.github.io/tripper/latest/LICENSE/ [tripper]: https://emmc-asbl.github.io/tripper [rdflib]: https://rdflib.readthedocs.io/en/stable/ [PyPI]: https://pypi.org/project/tripper diff --git a/mkdocs.yml b/mkdocs.yml index 087f910f..5fe357e1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -80,9 +80,11 @@ plugins: nav: - Home: index.md - Tutorial: tutorial.md + - Backend discovery: backend_discovery.md + - ... | api_reference/** + - Known issues: known-issues.md - License: LICENSE.md - Changelog: CHANGELOG.md - - ... | api_reference/** watch: - tripper From adea9f95af8b1ae3a6cfa89fc4772bdb970f8be3 Mon Sep 17 00:00:00 2001 From: Jesper Friis Date: Mon, 23 Sep 2024 23:00:50 +0200 Subject: [PATCH 2/3] Updated version of mkdocs-material due to safety volnerabeility 72715 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 16822f7e..04e5d5fb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,7 +66,7 @@ docs = [ "mkdocs==1.5.3", "mkdocs-autorefs==0.4.1", "mkdocs-awesome-pages-plugin==2.9.2", - "mkdocs-material==9.5.17", + "mkdocs-material==9.5.32", "mkdocstrings==0.22.0", "mkdocstrings-python-legacy==0.2.3", ] From 3afee2ed73198e04813b4e537f522c8ac282a0ca Mon Sep 17 00:00:00 2001 From: Jesper Friis Date: Mon, 23 Sep 2024 23:55:30 +0200 Subject: [PATCH 3/3] Ignore vulnerability instead of trying to fixing it... --- .github/workflows/ci_tests.yml | 2 ++ pyproject.toml | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml index b0018fdf..ad770004 100644 --- a/.github/workflows/ci_tests.yml +++ b/.github/workflows/ci_tests.yml @@ -36,12 +36,14 @@ jobs: # https://pyup.io/vulnerabilities/CVE-2021-34141/44717/ # 70612: Jinja2 vulnerability. Only used as subdependency for mkdocs++ in tripper. # https://data.safetycli.com/v/70612/97c/ + # https://data.safetycli.com/v/72715/97c/ # update to mkdocs>=9.5.32 safety_options: | --ignore=48547 --ignore=44715 --ignore=44716 --ignore=44717 --ignore=70612 + --ignore=72715 ## Build package run_build_package: true diff --git a/pyproject.toml b/pyproject.toml index 04e5d5fb..16822f7e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,7 +66,7 @@ docs = [ "mkdocs==1.5.3", "mkdocs-autorefs==0.4.1", "mkdocs-awesome-pages-plugin==2.9.2", - "mkdocs-material==9.5.32", + "mkdocs-material==9.5.17", "mkdocstrings==0.22.0", "mkdocstrings-python-legacy==0.2.3", ]