Skip to content

Commit 75fd668

Browse files
authored
Ports Docs to MkDocs (#729)
1 parent 7d9096b commit 75fd668

29 files changed

Lines changed: 4766 additions & 1582 deletions

.github/workflows/docs.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- 'docs/**'
8+
- 'mkdocs.yml'
9+
- '.readthedocs.yaml'
10+
pull_request:
11+
branches: [master]
12+
paths:
13+
- 'docs/**'
14+
- 'mkdocs.yml'
15+
- '.readthedocs.yaml'
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
name: Build Documentation
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Set up Python
26+
uses: actions/setup-python@v5
27+
with:
28+
python-version: '3.12'
29+
30+
- name: Install dependencies
31+
run: |
32+
pip install -r docs/requirements.txt
33+
34+
- name: Build docs
35+
run: mkdocs build --strict
36+
37+
- name: Upload artifact
38+
uses: actions/upload-artifact@v4
39+
if: github.event_name == 'pull_request'
40+
with:
41+
name: docs-preview
42+
path: site/
43+
retention-days: 7

.readthedocs.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Read the Docs configuration file for MkDocs
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html
3+
4+
version: 2
5+
6+
build:
7+
os: ubuntu-24.04
8+
tools:
9+
python: "3.12"
10+
11+
mkdocs:
12+
configuration: mkdocs.yml
13+
14+
python:
15+
install:
16+
- requirements: docs/requirements.txt

docs/Makefile

Lines changed: 0 additions & 177 deletions
This file was deleted.

0 commit comments

Comments
 (0)