diff --git a/.github/workflows/deploy-gh-pages.yml b/.github/workflows/deploy-gh-pages.yml index faa554a..7ead0e8 100644 --- a/.github/workflows/deploy-gh-pages.yml +++ b/.github/workflows/deploy-gh-pages.yml @@ -29,6 +29,10 @@ jobs: cancel-in-progress: false permissions: contents: write + env: + # See docs.yml: silences the properdocs notice pulled in by the nav and + # page generation plugins. + DISABLE_MKDOCS_2_WARNING: "true" steps: - uses: actions/checkout@v7 diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e35cbf3..34b0dd5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -10,6 +10,11 @@ permissions: jobs: docs: runs-on: ubuntu-latest + env: + # mkdocs-gen-files, literate-nav, section-index and redirects all depend on + # properdocs, which prints a notice about a possible MkDocs 2.0 on every + # build. Nothing here is acted on by it, so keep it out of the log. + DISABLE_MKDOCS_2_WARNING: "true" steps: - uses: actions/checkout@v7 with: diff --git a/docs/README.md b/docs/README.md index 51f50b6..f24f0ff 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,8 @@ +--- +description: >- + IKPyKit is a scikit-learn compatible Python library implementing Isolation Kernel methods for anomaly detection, clustering and change detection. +--- +