-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
88 lines (80 loc) · 2.08 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
site_name: Onyx-client
site_url: https://climb-tre.github.io/onyx-client/
repo_url: https://github.com/CLIMB-TRE/onyx-client/
repo_name: CLIMB-TRE/onyx-client
site_author: CLIMB-TRE
theme:
name: material
icon:
repo: fontawesome/brands/github
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
accent: purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: purple
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- navigation.tabs
- navigation.tabs.sticky
# - navigation.sections
# - navigation.top
# - toc.integrate
- content.code.copy
# extra:
# version:
# provider: mike
plugins:
- search
- autorefs
- mkdocstrings:
default_handler: python
handlers:
python:
options:
docstring_style: google
docstring_section_style: spacy
show_source: false
members_order: source
- with-pdf:
output_path: onyx-client.pdf
cover_subtitle: ""
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.magiclink
- toc:
permalink: true
extra_css:
- stylesheets/extra.css
nav:
- Overview: index.md
- Command-line interface:
- Getting started: cli/getting-started.md
- Documentation: cli/documentation.md
- Python API:
- Documentation:
- OnyxClient: api/documentation/client.md
- OnyxConfig: api/documentation/config.md
- OnyxEnv: api/documentation/env.md
- OnyxField: api/documentation/field.md
- Exceptions: api/documentation/exceptions.md
- Fields Reference:
- Types: fields/types.md
- Lookups: fields/lookups.md
- CLIMB-TRE: https://climb-tre.github.io