Skip to content

Commit 2480604

Browse files
authored
docs: add MkDocs documentation site (#7200)
1 parent 1593026 commit 2480604

141 files changed

Lines changed: 3446 additions & 2 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
- 'docs-requirements.txt'
11+
- '.github/workflows/docs.yml'
12+
tags:
13+
- 'v[0-9]+.[0-9]+.[0-9]+' # release tags only, not -rc
14+
pull_request:
15+
paths:
16+
- 'docs/**'
17+
- 'mkdocs.yml'
18+
- 'docs-requirements.txt'
19+
- '.github/workflows/docs.yml'
20+
workflow_dispatch:
21+
22+
permissions:
23+
contents: write
24+
25+
jobs:
26+
build:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- uses: actions/checkout@v6
30+
with:
31+
fetch-depth: 0
32+
33+
- name: Install uv
34+
uses: astral-sh/setup-uv@v7
35+
36+
- name: Configure git for mike
37+
if: github.event_name != 'pull_request'
38+
run: |
39+
git config user.name "github-actions[bot]"
40+
git config user.email "github-actions[bot]@users.noreply.github.com"
41+
42+
- name: Build docs (PR check)
43+
if: github.event_name == 'pull_request'
44+
run: uv run --with-requirements docs-requirements.txt mkdocs build --strict
45+
46+
- name: Deploy as latest (main branch)
47+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
48+
run: uv run --with-requirements docs-requirements.txt mike deploy --push --update-aliases latest
49+
50+
- name: Deploy release version
51+
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
52+
run: |
53+
# Extract minor version from tag, e.g. v2.11.2 -> v2.11
54+
VERSION=$(echo "${GITHUB_REF_NAME}" | sed 's/\.[0-9]*$//')
55+
uv run --with-requirements docs-requirements.txt mike deploy --push --update-aliases "${VERSION}" stable

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
/*.user
55
/*.user.*
66
/doc/
7-
build*/
8-
cmake-build-*/
7+
/build*/
8+
/cmake-build-*/
99
/debian/
1010
/*.vscode
1111
radio/src/tests/googletest*

docs-requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
mkdocs>=1.6
2+
mkdocs-material>=9.5
3+
mkdocs-minify-plugin>=0.8
4+
mike>=2.0

docs/assets/images/ACCESS.png

8.07 KB

docs/assets/images/DSM2.png

5.32 KB

docs/assets/images/EdgeTX_logo.png

33.1 KB

docs/assets/images/MULTI.png

8.88 KB

docs/assets/images/PPM.png

1.62 KB

docs/assets/images/PXX.png

5.15 KB

docs/assets/images/SBUS Normal.png

9.64 KB

0 commit comments

Comments
 (0)