forked from deepmodeling/DMFF
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
47 lines (38 loc) · 1.04 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
site_name: DMFF
nav:
nav:
- Home: index.md
- User Guide:
- 1. Introduction: user_guide/introduction.md
- 2. Installation: user_guide/installation.md
- 3. Basic usage: user_guide/usage.md
- 4. XML format force field: user_guide/xml_spec.md
- 5. Theory: user_guide/theory.md
- Developer Guide:
- 1. Introduction: dev_guide/introduction.md
- 2. Software architecture: dev_guide/arch.md
- 3. Coding conventions: dev_guide/convention.md
- 4. Document Writing: dev_guide/write_docs.md
- Modules:
- ADMP:
- Introduction: admp/readme.md
- Frontends: admp/frontend.md
- API: refs/
- About:
- License: license.md
theme: readthedocs
markdown_extensions:
- pymdownx.arithmatex:
generic: true
plugins:
- search
- gen-files:
scripts:
- docs/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings:
extra_javascript:
- assets/js/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js