From c2253b794a5875049d6c5db30fed887baf1ff103 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 12 Aug 2021 17:22:52 -0700 Subject: [PATCH] Specify full path to helper script in versioned website docs The "siteversion" Python script used by the versioned website templates is installed to `docs/siteversion/siteversion.py`. The configuration instructions for this script previously omitted the `docs` part of that path, which might cause confusion. --- workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md | 2 +- workflow-templates/deploy-mkdocs-versioned-poetry.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md b/workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md index 78d0c8e0..b59b2ba8 100644 --- a/workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md +++ b/workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md @@ -64,7 +64,7 @@ See the ["Deploy Website" workflow (versioned, MkDocs, Poetry) documentation](de The system is configured for the repository branch used as the source for the "dev" website version having the name `main`. If the project's development branch has another name, then configure it: - `on.push.branches[0]` in `deploy-cobra-mkdocs-versioned-poetry.yml` -- `DEV_BRANCHES` in [`siteversion/siteversion.py`](assets/deploy-mkdocs-versioned/siteversion/siteversion.py) +- `DEV_BRANCHES` in [`docs/siteversion/siteversion.py`](assets/deploy-mkdocs-versioned/siteversion/siteversion.py) #### Configure `.gitignore` diff --git a/workflow-templates/deploy-mkdocs-versioned-poetry.md b/workflow-templates/deploy-mkdocs-versioned-poetry.md index a543a4ab..28a100b1 100644 --- a/workflow-templates/deploy-mkdocs-versioned-poetry.md +++ b/workflow-templates/deploy-mkdocs-versioned-poetry.md @@ -48,7 +48,7 @@ See the ["Deploy Website" workflow (MkDocs, Poetry) documentation](deploy-mkdocs The system is configured for the repository branch used as the source for the "dev" website version having the name `main`. If the project's development branch has another name, then configure it: - `on.push.branches[0]` in `deploy-mkdocs-versioned-poetry.yml` -- `DEV_BRANCHES` in [`siteversion/siteversion.py`](assets/deploy-mkdocs-versioned/siteversion/siteversion.py) +- `DEV_BRANCHES` in [`docs/siteversion/siteversion.py`](assets/deploy-mkdocs-versioned/siteversion/siteversion.py) #### Configure Material theme for versioning