Skip to content

Commit c2253b7

Browse files
committed
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.
1 parent 6355b7c commit c2253b7

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ See the ["Deploy Website" workflow (versioned, MkDocs, Poetry) documentation](de
6464
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:
6565

6666
- `on.push.branches[0]` in `deploy-cobra-mkdocs-versioned-poetry.yml`
67-
- `DEV_BRANCHES` in [`siteversion/siteversion.py`](assets/deploy-mkdocs-versioned/siteversion/siteversion.py)
67+
- `DEV_BRANCHES` in [`docs/siteversion/siteversion.py`](assets/deploy-mkdocs-versioned/siteversion/siteversion.py)
6868

6969
#### Configure `.gitignore`
7070

workflow-templates/deploy-mkdocs-versioned-poetry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ See the ["Deploy Website" workflow (MkDocs, Poetry) documentation](deploy-mkdocs
4848
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:
4949

5050
- `on.push.branches[0]` in `deploy-mkdocs-versioned-poetry.yml`
51-
- `DEV_BRANCHES` in [`siteversion/siteversion.py`](assets/deploy-mkdocs-versioned/siteversion/siteversion.py)
51+
- `DEV_BRANCHES` in [`docs/siteversion/siteversion.py`](assets/deploy-mkdocs-versioned/siteversion/siteversion.py)
5252

5353
#### Configure Material theme for versioning
5454

0 commit comments

Comments
 (0)