/
mkdocs.yml
302 lines (268 loc) · 9.21 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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# vim: set ts=2 sw=2 sts=2 expandtab:
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
# Site information
site_name: Sherlock
site_description: User documentation for Sherlock, Stanford's HPC cluster.
site_author: Kilian Cavalotti
site_url: https://www.sherlock.stanford.edu/
# Repository
repo_name: SRCC // Open Source
repo_url: https://github.com/stanford-rc
edit_uri: www.sherlock.stanford.edu/edit/main/src/
# Copyright
copyright: >-
Copyright © 2014 - 2024 —
<a href='mailto:srcc-support@stanford.edu'>Stanford Research Computing</a><br/>
# Configuration
docs_dir: src
site_dir: site
# Validation
validation:
omitted_files: warn
absolute_links: relative_to_docs
unrecognized_links: warn
anchors: warn
nav:
omitted_files: info
# Theme options
theme:
name: material
custom_dir: overrides
# 404 page
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
language: en
features:
- announce.dismiss
- content.code.annotate
- navigation.indexes
#- navigation.instant # instant loading doesn't work well with our landing page
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
font:
text: Roboto
code: Roboto Mono
favicon: assets/images/logo_small.png
logo: assets/images/logo_small.png
logo_hero: assets/images/logo.png
banner: assets/images/banner.png
icon:
repo: fontawesome/brands/github
admonition:
note: octicons/note-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/light-bulb-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
# custom
sherlock: srcc/mono/sherlock
# Customization
extra_css:
- /assets/stylesheets/sh.css
extra:
analytics:
provider: google
property: !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"]
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by
using our <a href="https://github.com/stanford-rc/www.sherlock.stanford.edu/issues/new/?title=[Feedback]+{title}+-+{url}&labels=feedback"
target=_blank>feedback form</a>.
consent:
title: Cookie consent
description: >
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
generator: false
social:
- icon: fontawesome/solid/earth-americas
link: https://srcc.stanford.edu
name: SRCC website
- icon: fontawesome/brands/github
link: https://github.com/stanford-rc
name: SRCC on GitHub
- icon: fontawesome/brands/slack
link: https://srcc.slack.com/
name: SRCC Users Slack workspace
# custom
made_in: >-
<a href='https://www.google.com/maps/place/Stanford,+CA'>Stanford, California</a>
support_email: srcc-support@stanford.edu
purge_days: 90
# Plugins
plugins:
- search:
separator: "[\\s\\-,:!=\\[\\]()\"/]+|\\.(?!\\d)|&[lg]t;|(?!\\b)(?=[A-Z][a-z])"
- social:
cards_layout: default
cards_layout_options:
#logo: src/assets/images/logo_small.png
font_family: Roboto
background_image: src/assets/images/logo.png
background_color: "#8C1515"
- minify:
minify_html: true
minify_js: true
- macros:
on_error_fail: true
include_yaml:
- includes/data/software.yml
- includes/data/facts.yml
- redirects:
redirect_maps:
# external URLs
ondemand.md: https://login.sherlock.stanford.edu/
shell.md: https://login.sherlock.stanford.edu/pun/sys/shell/ssh
catalog.md: https://docs.google.com/spreadsheets/d/11CqpWe0XLoEbJEDAac6ag5nbrctkkZSJgRtG4hKh34w
order.md: https://docs.google.com/forms/d/e/1FAIpQLSd95TJaPbStWEZAUYHXNQedp9lQJMsTjyISjKmRMSpmL0rVqg/viewform
# nav refactor, legacy URLs
docs/overview/index.md: docs/index.md
docs/overview/introduction.md: docs/index.md
docs/overview/concepts.md: docs/concepts.md
docs/overview/orders.md: docs/orders.md
docs/overview/orders/process.md: docs/orders.md
docs/overview/tech/index.md: docs/tech/index.md
docs/overview/tech/specs.md: docs/tech/index.md
docs/overview/tech/facts.md: docs/tech/facts.md
docs/overview/tech/status.md: docs/tech/status.md
docs/overview/tech/glossary.md: docs/glossary.md
docs/overview/about.md: docs/credits.md
docs/getting-started/prerequisites.md: docs/getting-started/index.md
docs/storage/overview.md: docs/storage/index.md
docs/software/overview.md: docs/software/index.md
- tags
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: "#"
toc_depth: 4
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shortener: true
provider: github
user: stanford-rc
repo: sherlock
- pymdownx.caret
- pymdownx.tilde
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.escapeall:
hardbreak: true
nbsp: true
#
# Page tree
#
nav:
- Home:
- docs/index.md
- Concepts: docs/concepts.md
- Glossary: docs/glossary.md
- Ordering nodes: docs/orders.md
- Tech specs:
- docs/tech/index.md
- Facts: docs/tech/facts.md
- Status: docs/tech/status.md
- Credits: docs/credits.md
- Getting Started:
- docs/getting-started/index.md
- Connecting: docs/getting-started/connecting.md
- Submitting jobs: docs/getting-started/submitting.md
- User guide:
- Running jobs: docs/user-guide/running-jobs.md
- OnDemand: docs/user-guide/ondemand.md
- Specialized resources:
- GPU nodes: docs/user-guide/gpu.md
- Troubleshooting: docs/user-guide/troubleshoot.md
- Storage:
- docs/storage/index.md
- Filesystems: docs/storage/filesystems.md
- Data sharing: docs/storage/data-sharing.md
- Data protection: docs/storage/data-protection.md
- Data transfer: docs/storage/data-transfer.md
- Software:
- docs/software/index.md
- Modules: docs/software/modules.md
- List: docs/software/list.md
- Installation: docs/software/install.md
- Containers:
- docs/software/containers/index.md
- Singularity: docs/software/containers/singularity.md
- Tools:
- ClusterShell: docs/software/using/clustershell.md
- Usage:
- R: docs/software/using/R.md
- Julia: docs/software/using/julia.md
- Python: docs/software/using/python.md
- Anaconda: docs/software/using/anaconda.md
- Perl: docs/software/using/perl.md
- Matlab: docs/software/using/matlab.md
- Rclone: docs/software/using/rclone.md
- Spark: docs/software/using/spark.md
- MariaDB: docs/software/using/mariadb.md
- PostgreSQL: docs/software/using/postgresql.md
- Schrödinger: docs/software/using/schrodinger.md
- Quantum Espresso: docs/software/using/quantum-espresso.md
- Advanced topics:
- Connection options: docs/advanced-topics/connection.md
- Job management: docs/advanced-topics/job-management.md
- Node features: docs/advanced-topics/node-features.md