/
mkdocs.yml
154 lines (150 loc) · 4.32 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
repo_url: https://github.com/Quantum-Accelerators/quacc/
site_author: Andrew S. Rosen
site_description: >-
Quacc is a flexible and extensible platform for
high-throughput computational materials science and quantum chemistry.
site_name: quacc
site_url: https://quantum-accelerators.github.io/quacc/
nav:
- Home: index.md
- Installation Guide 🔧:
- install/install.md
- install/codes.md
- install/wflow_engines.md
- User Guide 🧠:
- Recipes:
- user/recipes/recipes_intro.md
- user/recipes/workflows.md
- user/recipes/recipes_list.md
- Settings Management:
- user/settings/settings.md
- user/settings/file_management.md
- user/settings/settings_list.md
- Workflow Basics:
- user/basics/wflow_overview.md
- user/basics/wflow_decorators.md
- user/basics/wflow_syntax.md
- Using a Workflow Engine:
- user/wflow_engine/wflow_engines1.md
- user/wflow_engine/wflow_engines2.md
- user/wflow_engine/executors.md
- Using a Database:
- user/db/context.md
- user/db/basics.md
- Miscellaneous:
- user/misc/file_transfers.md
- Code Documentation 📖: reference/
- Developer Guide 🤝:
- dev/contributing.md
- dev/docs.md
- Writing New Recipes:
- dev/recipes/jobs.md
- dev/recipes/flows.md
- For Maintainers 🚧:
- maintainers/internal.md
- About 📜:
- about/faq.md
- about/contributors.md
- about/changelog.md
- about/conduct.md
- about/license.md
theme:
favicon: images/quacc_favicon.png
features:
- content.action.edit
- content.code.copy
- content.code.select
- content.code.annotate
- content.tabs.link
- content.tooltips
- navigation.footer
- navigation.path
- navigation.tracking
- navigation.sections
- navigation.top
- search.highlight
- search.suggest
- search.share
- header.autohide
- toc.follow
logo: images/quacc_logo_wide.png
name: material
palette:
primary: orange
scheme: slate
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.snippets
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format ""
name: mermaid
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- autorefs
- social
- offline
- mkdocstrings:
default_handler: python
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://wiki.fysik.dtu.dk/ase/objects.inv
- https://pymatgen.org/objects.inv
- https://materialsproject.github.io/pymatgen-analysis-defects/objects.inv
- https://materialsproject.github.io/maggma/objects.inv
- https://materialsproject.github.io/emmet/objects.inv
- https://materialsproject.github.io/jobflow/objects.inv
- https://numpy.org/doc/stable/objects.inv
- https://docs.pydantic.dev/latest/objects.inv
- https://phonopy.github.io/phonopy/objects.inv
options:
docstring_style: numpy
docstring_section_style: list
separate_signature: true
merge_init_into_class: true
docstring_options:
ignore_init_summary: true
show_signature_annotations: true
signature_crossrefs: true
show_if_no_docstring: true
- gen-files:
scripts:
- docs/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
edit_uri: blob/main/docs/
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Quantum-Accelerators/