-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
139 lines (132 loc) · 4.14 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
134
135
136
137
138
site_name: GlitchyGames
site_url: https://glitchygames.github.io
repo_url: https://github.com/terrysimons/glitchygames
repo_name: glitchygames
nav:
- GlitchyGames Getting Started: "index.md"
- glitchygames API Reference:
- "glitchygames/index.md"
- glitchygames.api: "glitchygames/api/index.md"
- glitchygames.color: "glitchygames/color/index.md"
- glitchygames.engine: "glitchygames/engine/index.md"
- glitchygames.events: "glitchygames/events/index.md"
- glitchygames.examples: "glitchygames/examples/index.md"
- glitchygames.font: "glitchygames/fonts/index.md"
- glitchygames.game_objects: "glitchygames/game_objects/index.md"
- glitchygames.interfaces: "glitchygames/interfaces/index.md"
- glitchygames.movement: "glitchygames/movement/index.md"
- glitchygames.pixels: "glitchygames/pixels/index.md"
- glitchygames.sprites: "glitchygames/sprites/index.md"
- glitchygames.scenes: "glitchygames/scenes/index.md"
- glitchygames.templates: "glitchygames/templates/index.md"
- glitchygames.tools: "glitchygames/tools/index.md"
- glitchygames.ui: "glitchygames/ui/index.md"
validation:
omitted_files: warn
not_found: warn
absolute_links: warn
theme:
name: readthedocs
highlightjs: true
include_homepage_in_sidebar: true
prev_next_buttons_location: both
navigation_depth: 4
collapse_navigation: false
titles_only: true
sticky_navigation: true
features:
- navigation.expand
- navigation.indexes
- navigation.instant
- navigation.instant.progress
- navigation.path
- navigation.prefetch
- navigation.prune
- navigation.quick
- navigation.quick.progress
- navigation.scroll
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- toc.follow
- toc.integrate
markdown_extensions:
- attr_list
- md_in_html
- toc:
toc_depth: 3
permalink: "#"
separator: "-"
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.betterem
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.tasklist
- pymdownx.tilde
- pymdownx.emoji
- pymdownx.keys
- pymdownx.caret
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.details
plugins:
- autorefs
- macros
- search
- section-index
- mkdocstrings:
handlers:
python:
paths: [glitchygames]
rendering:
show_source: true
# options:
# allow_inspection: no
# show_bases: yes
# show_source: no
# show_root_heading: yes
# preload_modules: no
# allow_inspection: yes
# show_bases: yes
# heading_level: 2
# show_root_heading: yes
# show_root_toc_entry: yes
# show_root_full_path: yes
# show_root_members_full_path: yes
# show_object_full_path: yes
# show_category_heading: yes
# show_symbol_type_heading: yes
# show_symbol_type_toc: yes
# inherited_members: yes
# members: yes
# members_order: source
# group_by_category: yes
# show_submodules: yes
# summary: yes
# docstring_style: "google"
# docstring_section_style: table
# show_if_no_docstring: yes
# show_docstring_attributes: yes
# show_docstring_functions: yes
# show_docstring_classes: yes
# show_docstring_modules: yes
# show_docstring_description: yes
# show_docstring_examples: yes
# show_docstring_other_parameters: yes
# show_docstring_parameters: yes
# show_docstring_raises: yes
# show_docstring_receives: yes
# show_docstring_returns: yes
# show_docstring_yields: yes
# annotations_path: brief
# line_length: 100
# show_signature: yes
# show_signature_annotations: yes
# signature_crossrefs: yes
# separate_signature: yes
# unwrap_annotated: no