3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
moonraker/mkdocs.yml

117 lines
3.0 KiB
YAML
Raw Normal View History

docs: prepare documentation for readthedocs This commit adds mkdocs.yml and modifies the existing markdown documentation so that "readthedocs" can build documentation using "mkdocs". Included are many formatting changes and fixes to the existing documentation so that it shows up correctly when published. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 13:34:17 +03:00
site_name: Moonraker
docs: Update mkdocs version Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-06-29 03:27:22 +03:00
site_url: https://moonraker.readthedocs.io
docs: prepare documentation for readthedocs This commit adds mkdocs.yml and modifies the existing markdown documentation so that "readthedocs" can build documentation using "mkdocs". Included are many formatting changes and fixes to the existing documentation so that it shows up correctly when published. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 13:34:17 +03:00
repo_url: https://github.com/Arksine/moonraker
nav:
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>
2024-01-23 23:14:32 +03:00
- Installation: installation.md
- Configuration : configuration.md
docs: fixes minor typos Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
2023-02-23 17:06:41 +03:00
- 'Developer Documentation':
docs: add a changelog Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-02-22 00:54:29 +03:00
- Remote API: web_api.md
docs: prepare documentation for readthedocs This commit adds mkdocs.yml and modifies the existing markdown documentation so that "readthedocs" can build documentation using "mkdocs". Included are many formatting changes and fixes to the existing documentation so that it shows up correctly when published. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 13:34:17 +03:00
- Printer Objects: printer_objects.md
docs: remove references to plugins and create components.md Replace various notes with admonitions. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-19 00:16:36 +03:00
- Components: components.md
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>
2024-01-23 23:14:32 +03:00
- Contribution Guidelines: contributing.md
- Changelog: changelog.md
docs: prepare documentation for readthedocs This commit adds mkdocs.yml and modifies the existing markdown documentation so that "readthedocs" can build documentation using "mkdocs". Included are many formatting changes and fixes to the existing documentation so that it shows up correctly when published. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 13:34:17 +03:00
theme:
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>
2024-01-23 23:14:32 +03:00
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
docs: prepare documentation for readthedocs This commit adds mkdocs.yml and modifies the existing markdown documentation so that "readthedocs" can build documentation using "mkdocs". Included are many formatting changes and fixes to the existing documentation so that it shows up correctly when published. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 13:34:17 +03:00
plugins:
- search
markdown_extensions:
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>
2024-01-23 23:14:32 +03:00
- abbr
docs: remove references to plugins and create components.md Replace various notes with admonitions. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-19 00:16:36 +03:00
- admonition
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>
2024-01-23 23:14:32 +03:00
- 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
docs: clarify contributing documentation Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-02-11 00:53:11 +03:00
- pymdownx.inlinehilite
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>
2024-01-23 23:14:32 +03:00
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
docs: add new doc structure for peripheral requests This adds a new structure for API documentation, making each aspect visible and uniform. The parameters, response, and schema are collapsible, allowing for easier navigation. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-24 01:37:09 +03:00
- pymdownx.blocks.details:
types:
- name: details-new
class: new
- name: details-settings
class: settings
- name: details-note
class: note
- name: details-abstract
class: abstract
- name: details-info
class: info
- name: details-tip
class: tip
- name: details-success
class: success
- name: details-question
class: question
- name: details-warning
class: warning
- name: details-failure
class: failure
- name: details-danger
class: danger
- name: details-bug
class: bug
- name: details-example
class: example
- name: details-quote
class: quote
- name: api-example-response
class: example
title: "Example Response"
- name: api-response-schema
class: info
title: "Response Schema"
- name: api-parameters
class: info
title: "Parameters"
docs: add peripheral API documentation Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-23 19:15:04 +03:00
- tables
- compact_tables:
auto_insert_break: true
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>
2024-01-23 23:14:32 +03:00
extra_css:
- src/css/extras.css