From dead8618578a66185418fba087640782800b59ff Mon Sep 17 00:00:00 2001 From: janezlapajne Date: Tue, 20 Aug 2024 18:00:11 +0200 Subject: [PATCH 1/2] docs: Update links in README and mkdocs.yml --- README.md | 4 ++-- docs/license.md | 1 + mkdocs.yml | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 docs/license.md diff --git a/README.md b/README.md index 42cca14..f984365 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Contributing to SiaPy isn’t limited to coding. You can also: Not sure where to start or how your skills might fit in? Don’t hesitate to reach out! You can contact us via email, or connect with us directly on GitHub by opening a new issue or commenting on an existing one. -If you’re new to open-source contributions, check out our [guide](CONTRIBUTING.md) for helpful tips on getting started. +If you’re new to open-source contributions, check out our [guide](https://siapy.github.io/siapy-lib/contributing/) for helpful tips on getting started. ## Issues and new features @@ -65,4 +65,4 @@ Have a question? First, ensure that the setup process was completed successfully ## License -This project is licensed under the MIT License. See [LICENSE](LICENSE) for more details. +This project is licensed under the MIT License. See [LICENSE](https://siapy.github.io/siapy-lib/license/) for more details. diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..ced7428 --- /dev/null +++ b/docs/license.md @@ -0,0 +1 @@ +{{ external_markdown('https://raw.githubusercontent.com/siapy/siapy-lib/main/LICENSE.md', '') }} diff --git a/mkdocs.yml b/mkdocs.yml index d38cbfd..3d71cae 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -98,6 +98,7 @@ nav: - Plots: api/utils/plots.md - Contributing: contributing.md - Release Notes: changelog.md + - License: license.md markdown_extensions: # Python Markdown From 33529107a21b65126d94df60198343eb42ad3b6a Mon Sep 17 00:00:00 2001 From: janezlapajne Date: Tue, 20 Aug 2024 18:11:44 +0200 Subject: [PATCH 2/2] chore: Update pre-commit-config.yaml with autoupdate_branch and skip codespell --- .pre-commit-config.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4b234f7..aeb52b5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -54,3 +54,5 @@ repos: ci: autofix_commit_msg: "chore: [pre-commit.ci] Auto format from pre-commit.com hooks" autoupdate_commit_msg: "chore: [pre-commit.ci] pre-commit autoupdate" + autoupdate_branch: "develop" + skip: [codespell]