-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
110 lines (100 loc) · 2.67 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
site_name: 'estios: Economic Spatial and Temporal Input-Output Systems'
nav:
- Home: index.md
- Installation: install.md
- 'About': about.md
- 'Use':
- 'Theory': theory.md
- 'Data': data.md
- 'Specification': spec.md
- 'Scenarios': scenarios.md
- 'Contributing':
- 'Code of Conduct': code_of_conduct.md
- 'Development': contributing.md
- 'License': license.md
- '<tt>estios</tt>': estios/ # Must match GEN_DOC_PATH/ from docs/gen_ref_pages.py
- Issues: https://github.com/griff-rees/estios/issues
repo_url: https://github.com/griff-rees/estios/
watch:
- docs
- estios
theme:
name: material
features:
- content.code.copy
- content.tabs.link
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
plugins:
- search:
min_search_length: 3
lang: en
- markdown-exec
- include-markdown
- gen-files:
scripts:
- docs/gen_ref_pages.py
- literate-nav:
nav_file: DOC_STRINGS.md
- section-index
- mkdocstrings:
handlers:
python:
paths: [.]
options:
docstring_style: google
separate_signature: true
show_signature_annotations: true
line_length: 80
annotations_path: brief
signature_crossrefs: true
merge_init_into_class: true
# - bibtex:
# bib_file: !ENV ZOTERO_BIBTEX_URL
# csl_file: https://raw.githubusercontent.com/citation-style-language/styles/master/environment-and-planning.csl
# cite_inline: true
markdown_extensions:
- admonition
- pymdownx.details
- mkdocs-typer
- abbr
- attr_list
- tables
- footnotes
- pymdownx.magiclink
- pymdownx.arithmatex:
generic: true
- pymdownx.superfences:
custom_fences:
- name: math
class: arithmatex
format: !!python/object/apply:pymdownx.arithmatex.arithmatex_fenced_format
kwds:
mode: generic
tag: pre
# - pymdownx.snippets:
# auto_append:
# - docs/supplementary/glossary.md
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0/katex.min.css
extra_javascript:
- javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0/katex.min.js
- javascripts/tablesort.js
- https://unpkg.com/[email protected]/dist/tablesort.min.js