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

23 lines
621 B
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:
- 'User Documentation':
- Installation: installation.md
- Configuration : configuration.md
- User Changes: user_changes.md
- 'Client Developers':
- Client API: web_api.md
- Printer Objects: printer_objects.md
- API Changes: api_changes.md
- 'Backend Developers':
- Contributing: contributing.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: 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:
name: readthedocs
plugins:
- search
markdown_extensions:
- codehilite
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