forked from LLNL/merlin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
131 lines (123 loc) · 4.02 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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
site_name: Merlin
nav:
- Merlin: "index.md"
- Tutorial:
- Tutorial Overview: "tutorial/index.md"
- 0. Prerequisites: "tutorial/0_prerequisites.md"
- 1. Introduction: "tutorial/1_introduction.md"
- 2. Installation: "tutorial/2_installation.md"
- 3. Hello, World!: "tutorial/3_hello_world.md"
- 4. Run a Real Simulation: "tutorial/4_run_simulation.md"
- 5. Advanced Topics: "tutorial/5_advanced_topics.md"
- 6. Contribute to Merlin: "tutorial/6_contribute.md"
- 7. Port Your Own Application: "tutorial/7_port_application.md"
- User Guide:
- User Guide Overview: "user_guide/index.md"
- Installation: "user_guide/installation.md"
- Configuration:
- Configuration Overview: "user_guide/configuration/index.md"
- External Server: "user_guide/configuration/external_server.md"
- Merlin Server: "user_guide/configuration/merlin_server.md"
- Command Line Interface: "user_guide/command_line.md"
- Specification: "user_guide/specification.md"
- Variables: "user_guide/variables.md"
- Running Studies: "user_guide/running_studies.md"
- Interpreting Study Output: "user_guide/interpreting_output.md"
- Monitoring Studies:
- Monitoring Overview: "user_guide/monitoring/index.md"
- The Status Commands: "user_guide/monitoring/status_cmds.md"
- Querying Queues and Workers: "user_guide/monitoring/queues_and_workers.md"
- Monitoring Studies For Persistent Allocations: "user_guide/monitoring/monitor_for_allocation.md"
- Celery: "user_guide/celery.md"
- Docker: "user_guide/docker.md"
- Contributing: "user_guide/contributing.md"
- Examples:
- Examples Overview: "examples/index.md"
- Hello World Examples: "examples/hello.md"
- Feature Demo: "examples/feature_demo.md"
- Iterative Demo: "examples/iterative.md"
- Restart Examples: "examples/restart.md"
- HPC Examples: "examples/hpc.md"
- Flux Examples: "examples/flux.md"
- Slurm Examples: "examples/slurm.md"
- LSF Examples: "examples/lsf.md"
- FAQ: "faq.md"
- Reference Guide:
- Merlin Reference: "api_reference/index.md"
- API Reference: "api_reference/"
- Contact Us: "contact.md"
theme:
name: material
language: en
logo: assets/images/merlin_icon.png
features:
- header.autohide
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.instant
- navigation.indexes
- search.suggest
- search.highlight
- content.code.annotate
- content.code.copy
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
primary: black
accent: deep orange
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/toggle-switch
name: Switch to dark mode
primary: black
accent: deep orange
markdown_extensions:
- admonition
- attr_list
- md_in_html
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- markdown_grid_tables
plugins:
- glightbox
- search
- codeinclude:
title_mode: pymdownx.tabbed
# - gen-files:
# scripts:
# - docs/gen_ref_pages.py
# - mkdocstrings:
# handlers:
# python:
# paths: [merlin]
# options:
# docstring_style: sphinx
# - literate-nav:
# nav_file: SUMMARY.md
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/LLNL/merlin
name: Merlin on GitHub
extra_css:
- assets/stylesheets/extra.css
extra_javascript:
- assets/javascripts/swap_lp_image.js
copyright: Copyright © 2024 | Lawrence Livermore National Security