coke-oven-maintenance-plan/mkdocs.yml
ignis 43499f58e3
All checks were successful
Deploy Documentation / build-and-deploy (push) Successful in 3m17s
feat: add automated documentation building workflow and Google-style docstrings
2026-06-05 13:40:22 +00:00

48 lines
1.1 KiB
YAML

site_name: Coke Oven Maintenance Plan Reference Manual
theme:
name: material
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: red
accent: deep orange
toggle:
icon: material/brightness-4
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: red
accent: deep orange
toggle:
icon: material/brightness-7
name: Switch to dark mode
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- content.code.copy
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [.]
options:
docstring_style: google
show_source: true
show_root_heading: true
show_bases: true
nav:
- Home: index.md
- Python API Reference:
- Battery Module: python/battery.md
markdown_extensions:
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format