Files
PhotonVision/photon-lib/py/mkdocs.yml

40 lines
818 B
YAML
Raw Normal View History

2025-04-12 22:29:41 -05:00
site_name: PhotonLibPy Docs
2025-04-12 17:12:13 -05:00
theme:
2025-04-14 00:36:02 -05:00
name: material
2025-04-12 22:37:18 -05:00
favicon: docs/favicon.ico # If you want a favicon
2025-04-12 22:41:36 -05:00
logo: logo.svg # Optional logo
2025-04-13 08:09:17 -05:00
palette:
primary: custom
2025-04-12 17:12:13 -05:00
plugins:
2025-04-13 23:29:32 -05:00
- search:
2025-04-12 17:12:13 -05:00
- mkdocstrings:
2025-04-12 22:29:41 -05:00
handlers:
python:
2025-04-14 00:36:02 -05:00
options:
show_source: false
2025-04-12 22:54:50 -05:00
paths:
2025-04-12 22:35:20 -05:00
- "."
2025-04-12 22:29:41 -05:00
- gen-files:
scripts:
- gen_api_docs.py
- literate-nav
- section-index
2025-04-13 10:43:40 -05:00
# To exclude files, add them under glob using their
2025-04-13 10:38:44 -05:00
# path from photonlibpy prepended by reference/
# Additionally, change the extension from .py to .md
2025-04-13 10:22:10 -05:00
- exclude:
glob:
- "reference/packet.md"
2025-04-13 10:51:39 -05:00
- "reference/generated/*"
2025-04-12 17:12:13 -05:00
nav:
- Home: index.md
2025-04-12 22:29:41 -05:00
- Reference: reference/SUMMARY.md
2025-04-13 08:09:17 -05:00
extra_css:
- stylesheets/extra.css
2025-04-13 23:29:32 -05:00
extra_javascript:
- js/exclude-details.js