-
Notifications
You must be signed in to change notification settings - Fork 42
Expand file tree
/
Copy pathmkdocs.yml
More file actions
170 lines (149 loc) · 5.27 KB
/
mkdocs.yml
File metadata and controls
170 lines (149 loc) · 5.27 KB
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
#
# MKDOCS CONFIGURATION FILE
# https://www.mkdocs.org/user-guide/configuration/
#
# https://github.com/google/bayesnf/blob/main/mkdocs.yml
# https://github.com/google/ml-metadata/blob/master/mkdocs.yml
# https://github.com/google/temporian/blob/main/docs/mkdocs.yml
# https://github.com/mesop-dev/mesop/blob/main/mkdocs.yml
#
site_name: Smart Control Project Documentation
site_description: "Google Open Source Smart Buildings Control"
site_dir: docs_site # NOTE: should not be within the docs dir
site_url: https://google.github.io/sbsim/
repo_url: https://github.com/google/sbsim
repo_name: google/sbsim
edit_uri: edit/copybara_push/docs/
#
# THEME / STYLE
#
theme:
name: material # default: (readthedocs / mkdocs), third-party: material
features:
#- navigation.tabs # puts tabs under top navbar
- navigation.sections # splits left sidebar into sections
- navigation.path # breadcrumbs ?
- navigation.top # back to top button
- navigation.footer # next and back buttons
#- navigation.indexes # allows a directory to have an index.md
- content.action.edit # Enables the "Edit this page" button
- content.action.view # Enables the "View source of this page" button
favicon: assets/images/favicon.ico
# https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
#icon:
# logo: fontawesome/brands/google # material/glasses
logo: assets/images/google-open-source-logo-large.png
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
palette:
# Light Mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: light blue
accent: light blue
toggle:
icon: material/weather-sunny # material/brightness-7
name: Switch to dark mode
# Dark Mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: light blue
accent: light blue
toggle:
icon: material/weather-night # material/brightness-2
name: Switch to light mode
#extra_css:
# - assets/stylesheets/google-style.css
#
# NAVIGATION / TOC
#
nav:
- 'Home': index.md
- 'Local Development':
- 'Setup':
- 'Overview': setup.md
- 'Linux': setup/linux.md
- 'Mac': setup/mac.md
- 'Docker': setup/docker.md
- 'Contributing': contributing.md
- 'Documentation Site': docs-site.md
- 'API Reference':
- api/config.md
- 'Dataset':
- api/dataset/dataset.md
- api/dataset/partition.md
- api/environment.md
- api/models.md
- 'Reinforcement Learning':
- api/reinforcement_learning/agents.md
- api/reinforcement_learning/observers.md
- api/reinforcement_learning/policies.md
- api/reinforcement_learning/replay_buffer.md
- api/reinforcement_learning/scripts.md
- api/reinforcement_learning/utils.md
- api/reward.md
- 'Simulator':
- 'Overview': api/simulator/simulator.md
- api/simulator/building.md
- api/simulator/devices.md
- api/simulator/occupancy.md
- api/simulator/weather.md
- api/simulator/utils.md
#
# PLUGINS / EXTENSIONS
#
markdown_extensions:
- toc:
permalink: "#" # adds clickable link anchors for all headings
# enable language-specific syntax highlighting:
- pymdownx.highlight:
anchor_linenums: true
#line_spans: __span
pygments_lang_class: true
#- pymdownx.inlinehilite # For inline code highlighting
#- pymdownx.snippets
- pymdownx.superfences
# MATHJAX EQUATIONS CONFIG, PART 1 OF 2
# https://mrkeo.github.io/reference/mathjax/
# https://squidfunk.github.io/mkdocs-material/reference/math/#mathjax-mkdocsyml
# https://www.mathjax.org/
- pymdownx.arithmatex:
generic: true
extra_javascript:
# MATHJAX EQUATIONS CONFIG, PART 2 OF 2
- assets/javascripts/mathjax_config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- search
- autorefs # enables linking to other methods (maybe not working?)
#
# API DOCS
# https://mkdocstrings.github.io/python/usage/
#
- mkdocstrings:
default_handler: python
handlers:
python:
paths:
- . # look in the current directory for the "smart_control" dir
options:
docstring_style: google
docstring_section_style: "table" # "table", "list", "spacy"
show_source: false
show_signature_annotations: true # type hints
show_root_heading: true # HTML heading for the import path
show_root_full_path: true # show full module import path
show_root_members_full_path: false
show_root_toc_entry: true
members_order: alphabetical # "alphabetical", "source", "__all__"
filters: ["!^_"] # exclude private / protected members
inherited_members: true
show_inheritance_diagram: true # paid feature?
line_length: 80
show_category_heading: false # "Classes", "Functions" etc.
show_symbol_type_heading: true # "Class", "Function", etc
show_symbol_type_toc: true # "mod", "class", "meth", etc.
merge_init_into_class: true
show_if_no_docstring: false
separate_signature: true
annotations_path: "brief" # "brief", "source", or "full"