forked from slaclab/lume-services
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
108 lines (103 loc) · 3.15 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
site_name: lume-services
site_url: https://slaclab.github.io/lume-services
repo_url: https://github.com/slaclab/lume-services
nav:
- Overview:
- LUME-Services: index.md
- Configuration: config.md
- Model Packaging: model_packaging.md
- Workflows: workflows.md
- CLI: cli.md
- Demo: demo.md
- Packaging: model_packaging.md
- Services:
- File Service: services/files.md
- Results DB Service: services/results.md
- HPC Service: services/hpc.md
- Modeling Service: services/models.md
- Scheduling Service: services/scheduling.md
- API:
- Tasks:
- api/tasks.md
- Files:
- File: api/files/files.md
- Serializers: api/files/serializers.md
- Utils: api/files/utils.md
- Models: api/models.md
- Results: api/results.md
- Config: api/config.md
- Errors: api/errors.md
- Utils: api/utils.md
- Flows: api/flows.md
- Utils: api/utils.md
- Services:
- Results:
- Results Database Service: api/services/results/results.md
- Database: api/services/results/db.md
- Files:
- File Service: api/services/files/files.md
- Filesystems: api/services/files/filesystems.md
- Model:
- Model Database Service: api/services/models/models.md
- Database: api/services/models/db.md
- Scheduling:
- Scheduling Service: api/services/scheduling/scheduling.md
- Backends: api/services/scheduling/backends.md
- Developer:
- Setup: developer/setup.md
- Documentation: developer/documentation.md
- TODO: developer/todo.md
- Cluster Architecture: developer/cluster.md
- Configuration: developer/configuration.md
- Docker Image: developer/docker_image.md
- Services:
- File: developer/services/file.md
- Scheduling: developer/services/scheduling.md
- Results: developer/services/results.md
- Models: developer/services/models.md
plugins:
- macros
- mkdocs-jupyter
- search:
separator: '[\s\-\.]'
- mkdocstrings:
default_handler: python
handlers:
python:
selection:
inherited_members: true
filters:
- "!^_" # exlude all members starting with _
- "^__init__$" # but always include __init__ modules and methods
- "!^logger"
rendering:
show_source: true
show_root_toc_entry: false
show_root_full_path: true
show_root_heading: true
show_if_no_docstring: true
# show_signature_annotations: true
#separate_signature: true
merge_init_into_class: true
show_submodules: true
heading_level: 2
members_order: source
show_category_heading: true
theme:
name: material
features:
- toc.integrate
- toc.follow
- navigation.top
- navigation.tabs
markdown_extensions:
- pymdownx.tasklist
- mkdocs-click
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# - attr_list
extra_css:
- stylesheets/extra.css