Build documentation with `mkdocs` - #38

Merged

peytondmurray merged 22 commits into

google:masterfrom

smokestacklightnin:ci/docs/use-mkdocs

Aug 12, 2025

Commits on Sep 25, 2024

Add minimum viable mkdocs configuration
smokestacklightnin
committed
89c36bd
Add examples section
smokestacklightnin
committed
952f431
Add links to api docs and overviews
smokestacklightnin
committed
b44c44f
Get api docs up and running
smokestacklightnin
committed
660b153
Add `__all__` to `__init__.py` files to include correct classes
smokestacklightnin
committed
5ee610f
Exclude test modules from docs
smokestacklightnin
committed
4d3fef0
Use correct module
smokestacklightnin
committed
9dd8dc2
Add docs deployment workflow
smokestacklightnin
committed
fed0cf8
Include all correct modules/classes/functions
smokestacklightnin
committed
beb9c37
Fix button rendering
smokestacklightnin
committed
7dc3f4b
Fix formatting, including admonitions
smokestacklightnin
committed
557ab21
Fix broken link
smokestacklightnin
committed
a31f0b2
Use README.md as homepage for docs
smokestacklightnin
committed
1c7d161
Fix links
smokestacklightnin
committed
6790d80
Remove debug triggers from docs deployment workflow
smokestacklightnin
committed
8360a97
Remove deprecated api docs
smokestacklightnin
committed
00d22bc

Commits on Oct 2, 2024

Fix triggers
smokestacklightnin
committed
920f56b
Move docs requirements to common location
smokestacklightnin
committed
5baf266
Only trigger on pushes to master
smokestacklightnin
committed
043aee3

Commits on Oct 14, 2024

Remove unnecessary newline characters
smokestacklightnin
committed
6fb6fbc

Commits on Aug 8, 2025

Merge remote-tracking branch 'upstream/master' into ci/docs/use-mkdocs
smokestacklightnin
committed
213c53f

Commits on Aug 12, 2025

Move docs location to default `docs` directory
smokestacklightnin
committed
85345a6