docs: move to material theme

The material theme is more feature complete and flexibile,
providing better documentation for APIs and such.  This
commit is just the initial move.  The documents are functional,
but the layout and color schemes are subject to change.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2024-01-23 15:14:32 -05:00
parent 948b842351
commit 931e88b9f0
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
3 changed files with 69 additions and 12 deletions

View File

@ -1,3 +1,2 @@
mkdocs==1.5.3
pymdown-extensions==10.7
mkdocs-material==9.5.4
compact_tables@git+https://github.com/Arksine/markdown-compact-tables@v1.0.0

7
docs/src/css/extras.css Normal file
View File

@ -0,0 +1,7 @@
[data-md-color-scheme="slate"] {
--md-table-color: rgb(20, 20, 20);
}
thead th {
background-color: var(--md-table-color)
}

View File

@ -2,26 +2,77 @@ site_name: Moonraker
site_url: https://moonraker.readthedocs.io
repo_url: https://github.com/Arksine/moonraker
nav:
- 'User Documentation':
- Installation: installation.md
- Configuration : configuration.md
- 'Developer Documentation':
- Remote API: web_api.md
- Printer Objects: printer_objects.md
- Components: components.md
- 'Miscellaneous':
- Contributing: contributing.md
- Contribution Guidelines: contributing.md
- Changelog: changelog.md
theme:
name: readthedocs
name: material
palette:
- scheme: default
primary: blue grey
accent: light blue
toggle:
icon: material/weather-sunny
name: Switch to Dark Mode
- scheme: slate
primary: black
accent: light blue
toggle:
icon: material/weather-night
name: Switch to Light Mode
font:
text: Roboto
code: Roboto Mono
features:
- navigation.top
- navigation.instant
- navigation.indexes
- navigation.expand
- toc.follow
- content.tabs.link
- search.share
- search.highlight
- search.suggest
- content.code.copy
- content.code.annotations
plugins:
- search
markdown_extensions:
- abbr
- admonition
- pymdownx.superfences
- pymdownx.highlight:
use_pygments: false
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- tables
- compact_tables:
auto_insert_break: true
extra_css:
- src/css/extras.css