Initial work on mkdocs documentation

This commit is contained in:
Darren Eberly
2021-12-25 22:20:36 -05:00
parent b8052b9035
commit 6b7d88f131
26 changed files with 199 additions and 606 deletions

44
mkdocs.yml Normal file
View File

@@ -0,0 +1,44 @@
site_name: PyTiled Parser
site_url: https://learn-arcade.dev/
repo_url: https://github.com/benjamin-kirkbride/pytiled_parser
repo_name: benjamin-kirkbride/pytiled_parser
theme:
features:
- search.suggest
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: cyan
accent: pink
toggle:
icon: material/lightbulb
name: Switch to light mode
plugins:
- search
- mkdocstrings:
handlers:
python:
selection:
filters:
- "!^__"
- "!^_"
watch:
- pytiled_parser
nav:
- PyTiled Parser: index.md
- API Reference:
- reference/common_types.md
- reference/layer.md
- reference/parser.md
- reference/properties.md
- reference/tiled_map.md
- reference/tiled_object.md
- reference/tileset.md
- reference/wang_set.md
- reference/world.md