From 94f02d70f7eb335a0fc8fdcc82e8ded0aaaf2638 Mon Sep 17 00:00:00 2001 From: Upstream Data Date: Tue, 27 Aug 2024 16:16:04 -0600 Subject: [PATCH] Update mkdocs and github pages deploy. Fixing an issue with the root level of the github pages deploy not being where mkdocs expects it to be. --- .github/workflows/gh-pages.yml | 3 +++ .pre-commit-config.yaml | 6 ++++++ mkdocs.yml | 1 + 3 files changed, 10 insertions(+) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 529019a5..1fd90c54 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -11,6 +11,9 @@ on: - "pyproject.toml" - "docs/**" +env: + SITE_URL: https://upstreamdatainc.github.io/goosebit + jobs: publish: runs-on: ubuntu-latest diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4e563df1..ff60b207 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -7,6 +7,12 @@ repos: hooks: - id: trailing-whitespace - id: check-yaml + name: check-yaml for mkdocs.yml + files: ^mkdocs\.yml$ + args: [--unsafe] + - id: check-yaml + name: check-yaml for other YAML files + exclude: ^mkdocs\.yml$ - id: check-added-large-files - repo: https://github.com/psf/black rev: 24.8.0 diff --git a/mkdocs.yml b/mkdocs.yml index 4dd31026..a35b94ea 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,7 @@ repo_url: https://github.com/UpstreamDataInc/goosebit repo_name: gooseBit site_name: gooseBit +site_url: !ENV SITE_URL theme: name: material logo: img/goosebit-logo.svg