mirror of https://github.com/JoshKarpel/spiel
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
2.0 KiB
YAML
92 lines
2.0 KiB
YAML
site_name: Spiel
|
|
|
|
site_url: https://www.spiel.how
|
|
repo_url: https://github.com/JoshKarpel/spiel
|
|
edit_uri: edit/main/docs/
|
|
|
|
extra_css:
|
|
- assets/style.css
|
|
|
|
watch:
|
|
- spiel/
|
|
|
|
theme:
|
|
name: material
|
|
favicon: assets/favicon.png
|
|
icon:
|
|
logo: fontawesome/solid/person-chalkboard
|
|
palette:
|
|
- scheme: default
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
media: "(prefers-color-scheme: light)"
|
|
- scheme: slate
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
media: "(prefers-color-scheme: dark)"
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.sections
|
|
- navigation.indexes
|
|
- toc.follow
|
|
- content.code.annotate
|
|
- content.code.copy
|
|
|
|
plugins:
|
|
- tags
|
|
- search
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
docstring_section_style: spacy
|
|
merge_init_into_class: true
|
|
show_if_no_docstring: false
|
|
show_source: false
|
|
members_order: source
|
|
import:
|
|
- https://docs.python.org/3/objects.inv
|
|
- https://rich.readthedocs.io/en/stable/objects.inv
|
|
- https://textual.textualize.io/objects.inv
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets:
|
|
base_path: ['docs', '.']
|
|
check_paths: true
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- attr_list
|
|
- def_list
|
|
- md_in_html
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- tables
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/JoshKarpel/spiel
|
|
name: Spiel on GitHub
|
|
|
|
nav:
|
|
- Introduction: index.md
|
|
- quickstart.md
|
|
- presenting.md
|
|
- slides.md
|
|
- transitions.md
|
|
- api.md
|
|
- gallery.md
|
|
- contributing.md
|
|
- changelog.md
|