/
mkdocs.yml
46 lines (46 loc) · 1.22 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
site_name: Valor
repo_url: https://github.com/striveworks/valor
theme:
name: material
features:
- navigation.expand
palette:
scheme: slate
primary: deep purple
extra_javascript:
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
nav:
- Overview: "index.md"
- Installation: "installation.md"
- Basic Usage: "basic_usage.md"
- Sample Notebooks: "https://github.com/Striveworks/valor/blob/main/examples/"
- Metadata & Filtering: "metadata_and_filtering.md"
- Metrics: "metrics.md"
- Endpoints: "endpoints.md"
- Technical Concepts: "technical_concepts.md"
- Contributing & Development: "contributing.md"
- Python Client API: "client_api"
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.arithmatex:
generic: true
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
docstring_style: numpy
- include_dir_to_nav:
sort_file: true
sort_directory: true
- swagger-ui-tag:
syntaxHighlightTheme: monokai
tryItOutEnabled: False
supportedSubmitMethods: []