Generate a mkdocs github page + Migrate documentation links to use it (#1414)

* Approx first pass?

* Update docs.yml

* Filling out menu

* Update GettingStarted.md

* Index docs links

* Update index.md

* Update README.md

* Link redirection

* More link rewrite

* Update HallSensor.md

* Split up flashing

* Derp

* Flashing links
This commit is contained in:
Ben V. Brown
2022-09-22 13:10:01 +10:00
committed by GitHub
parent c89db78b45
commit 6fab3e5252
17 changed files with 742 additions and 304 deletions

35
.github/workflows/docs.yml vendored Normal file
View File

@@ -0,0 +1,35 @@
name: Docs
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request
push:
branches: [ dev, docs ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
deploy-docs:
# The type of runner that the job will run on
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-python@v4
- run: pip install --upgrade pip && pip install mkdocs mkdocs-gen-files
- run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
- name: Publish docs
run: mkdocs gh-deploy