-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
133 lines (122 loc) · 3.43 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
site_name: OSR Console Documentation
site_author: Marsh Macy
site_description: Adventures in turn-based text
site_url: https://osrapps.github.io/osr-console
repo_name: osr-console
repo_url: https://github.com/osrapps/osr-console
watch:
- "docs/"
- "osrlib/osrlib/"
theme:
name: material
logo: assets/logo-osr-apps.png
favicon: assets/logo-osr-apps.png
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue grey
accent: orange
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue grey
accent: orange
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Actor
code: Chivo Mono
#text: Sora # BIG!
#code: Martian Mono # BIG!
features:
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.progress
- navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- toc.follow
- search.suggest
- search.share
- header.autohide
markdown_extensions:
- admonition
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
extra_css:
- "main.css"
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [osrlib]
import:
- https://docs.python.org/3/objects.inv
options:
docstring_options:
ignore_init_summary: true
docstring_section_style: list
filters: ["!^_"]
heading_level: 2
inherited_members: false
merge_init_into_class: true
separate_signature: true
show_root_heading: true
show_root_full_path: false
show_signature_annotations: true
show_source: false
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
summary: true
unwrap_annotated: true
nav:
- About:
- index.md
- Packages:
- osrlib.md
- osrgame.md
- tests.md
- API reference:
- reference/index.md
- Modules:
- ability: reference/ability.md
- adventure: reference/adventure.md
- character_classes: reference/character_classes.md
- constants: reference/constants.md
- dice_roller: reference/dice_roller.md
- dungeon: reference/dungeon.md
- dungeon_assistant: reference/dungeon_assistant.md
- encounter: reference/encounter.md
- enums: reference/enums.md
- inventory: reference/inventory.md
- item: reference/item.md
- item_factories: reference/item_factories.md
- monster: reference/monster.md
- monster_manual: reference/monster_manual.md
- party: reference/party.md
- player_character: reference/player_character.md
- quest: reference/quest.md
- saving_throws: reference/saving_throws.md
- treasure: reference/treasure.md
- utils: reference/utils.md