/
mkdocs.yaml
110 lines (98 loc) · 2.79 KB
/
mkdocs.yaml
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
site_name: 'monarch-py'
repo_name: 'monarch-app/backend'
repo_url: 'https://github.com/monarch-initiative/monarch-app/tree/main/backend'
site_url: 'https://monarch-app.monarchinitiative.org/docs/'
nav:
- Welcome: 'index.md'
- Usage:
- Usage: 'Usage/index.md'
- CLI: 'Usage/CLI.md'
- Interfaces:
- Overview: 'Usage/Interfaces/index.md'
- Entity: 'Usage/Interfaces/Entity.md'
- Association: 'Usage/Interfaces/Association.md'
- Query: 'Usage/Interfaces/Query.md'
- Search: 'Usage/Interfaces/Search.md'
- Implementations:
- Overview: 'Usage/Implementations/index.md'
- Solr: 'Usage/Implementations/Solr.md'
- SQL: 'Usage/Implementations/SQL.md'
# - OAK: 'Usage/Implementations/OAK.md'
- FastAPI:
- Overview: 'FastAPI/index.md'
- Endpoints:
- 'FastAPI/Endpoints/index.md'
- API Reference: 'API-Reference/index.md'
- Response Data Model: 'Data-Model/index.md'
theme:
name: 'material'
docs_dir: docs/
logo: 'images/monarch-initiative.png'
favicon: 'images/favicon.ico'
features:
- navigation.expand
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-2
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to light mode
font:
text: 'Source Sans Pro'
code: 'Source Sans Pro Mono'
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [./backend]
import:
- https://docs.python.org/3/objects.inv
- https://mkdocstrings.github.io/objects.inv
- https://mkdocstrings.github.io/griffe/objects.inv
options:
docstring_style: google
docstring_options:
docstring_section_style: table
ignore_init_summary: yes
merge_init_into_class: yes
# separate_signature: yes
show_signature: no
show_source: no
show_root_full_path: no
show_root_toc_entry: False
filters:
- '!^_[^_]'
# - '^_[^_]'
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.emoji
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.tabbed
- attr_list
- pymdownx.betterem:
smart_enable: all
- pymdownx.snippets:
check_paths: true
- pymdownx.tabbed:
alternate_style: true
extra:
social:
- icon: 'fontawesome/solid/house'
link: 'https://monarchinitiative.org'
- icon: 'fontawesome/brands/github-alt'
link: 'https://github.com/monarch-initiative/'