This commit is contained in:
CaCO3
2025-02-15 22:15:47 +01:00
parent 03e9214bb8
commit 5671505001
3 changed files with 5 additions and 2 deletions

View File

@@ -34,7 +34,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-python@v5
- run: |
pip install --upgrade pip && pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin mkdocs-material mkdocs-enumerate-headings-plugin
pip install --upgrade pip && pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin mkdocs-material mkdocs-enumerate-headings-plugin mkdocs-redirects-plugin
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'

View File

@@ -54,7 +54,7 @@ To test it locally:
1. Install the required tools (See also [.github/workflows/build-docs.yaml](.github/workflows/build-docs.yaml)):
```
pip install --upgrade pip
pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin mkdocs-material pymdown-extensions mkdocs-enumerate-headings-plugin
pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin mkdocs-material pymdown-extensions mkdocs-enumerate-headings-plugin mkdocs-redirects-plugin
```
1. In the main folder of the repo, call `mkdocs serve` (and keep it running).
This will locally generate the documentation.

View File

@@ -22,6 +22,9 @@ plugins:
- enumerate-headings:
increment_across_pages: false
toc_depth: 6
- redirects:
redirect_maps:
'Parameters/#parameter-numberanalogtodigittransitionstart': 'Parameters/#parameter-analogtodigittransitionstart'
# The navigation is configured in the docs/nav.yml file!