Skip to content

Commit fde0ea0

Browse files
committed
Add MkDocs workflow.
1 parent 65e4ae2 commit fde0ea0

File tree

5 files changed

+143
-0
lines changed

5 files changed

+143
-0
lines changed

.github/workflows/build-pages.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: GitHub Pages
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
pull_request:
7+
8+
jobs:
9+
gh-pages-build:
10+
name: Build GitHub Pages
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v5
15+
- uses: actions/setup-python@v6
16+
with:
17+
python-version: "3.13"
18+
cache: "pip"
19+
20+
- run: pip install -r requirements.txt
21+
22+
- name: build docs
23+
run: |
24+
mkdocs build
25+
26+
- name: Upload static files as artifact
27+
id: deployment
28+
uses: actions/upload-pages-artifact@v3
29+
with:
30+
path: site/
31+
32+
deploy:
33+
name: Deploy GitHub Pages
34+
needs: gh-pages-build
35+
36+
concurrency:
37+
group: "github-pages"
38+
cancel-in-progress: false
39+
40+
permissions:
41+
pages: write
42+
id-token: write
43+
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
48+
runs-on: ubuntu-latest
49+
steps:
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ libwebp
1111
**/.cxx
1212
display-p3/third_party
1313

14+
# MkDocs build output
15+
/site

docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Welcome to MkDocs
2+
3+
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
4+
5+
## Commands
6+
7+
* `mkdocs new [dir-name]` - Create a new project.
8+
* `mkdocs serve` - Start the live-reloading docs server.
9+
* `mkdocs build` - Build the documentation site.
10+
* `mkdocs -h` - Print help message and exit.
11+
12+
## Project layout
13+
14+
mkdocs.yml # The configuration file.
15+
docs/
16+
index.md # The documentation homepage.
17+
... # Other markdown pages, images and other files.

mkdocs.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
site_name: Android NDK Samples
2+
site_url: !ENV SITE_URL
3+
repo_url: !ENV REPO_URL
4+
edit_uri: edit/main/docs/
5+
6+
theme:
7+
name: material
8+
features:
9+
- content.action.edit
10+
- content.action.view
11+
12+
palette:
13+
# Palette toggle for automatic mode
14+
- media: "(prefers-color-scheme)"
15+
toggle:
16+
icon: material/brightness-auto
17+
name: Switch to light mode
18+
19+
# Palette toggle for light mode
20+
- media: "(prefers-color-scheme: light)"
21+
scheme: default
22+
toggle:
23+
icon: material/brightness-7
24+
name: Switch to dark mode
25+
26+
# Palette toggle for dark mode
27+
- media: "(prefers-color-scheme: dark)"
28+
scheme: slate
29+
toggle:
30+
icon: material/brightness-4
31+
name: Switch to system preference

requirements.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
alabaster==1.0.0
2+
babel==2.17.0
3+
backrefs==5.9
4+
certifi==2025.8.3
5+
charset-normalizer==3.4.3
6+
click==8.3.0
7+
colorama==0.4.6
8+
docutils==0.21.2
9+
ghp-import==2.1.0
10+
idna==3.10
11+
imagesize==1.4.1
12+
Jinja2==3.1.6
13+
Markdown==3.9
14+
MarkupSafe==3.0.3
15+
mergedeep==1.3.4
16+
mkdocs==1.6.1
17+
mkdocs-get-deps==0.2.0
18+
mkdocs-material==9.6.21
19+
mkdocs-material-extensions==1.3.1
20+
packaging==25.0
21+
paginate==0.5.7
22+
pathspec==0.12.1
23+
platformdirs==4.4.0
24+
Pygments==2.19.2
25+
pymdown-extensions==10.16.1
26+
python-dateutil==2.9.0.post0
27+
PyYAML==6.0.3
28+
pyyaml_env_tag==1.1
29+
requests==2.32.5
30+
roman-numerals-py==3.1.0
31+
six==1.17.0
32+
snowballstemmer==3.0.1
33+
Sphinx==8.2.3
34+
sphinxcontrib-applehelp==2.0.0
35+
sphinxcontrib-devhelp==2.0.0
36+
sphinxcontrib-htmlhelp==2.1.0
37+
sphinxcontrib-jsmath==1.0.1
38+
sphinxcontrib-qthelp==2.0.0
39+
sphinxcontrib-serializinghtml==2.0.0
40+
urllib3==2.5.0
41+
watchdog==6.0.0

0 commit comments

Comments
 (0)