mdpp/mkdocs.yml at main · FridrichMethod/mdpp · GitHub

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
site_name: mdpp
site_description: MD simulation pre- and post-processing
repo_url: https://github.com/FridrichMethod/mdpp

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            members_order: source
            merge_init_into_class: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - User Guide:
      - Core: guide/core.md
      - Analysis: guide/analysis.md
      - Cheminformatics: guide/chem.md
      - Plots: guide/plots.md
      - Preparation: guide/prep.md
      - Scripts: guide/scripts.md
  - API Reference:
      - Core: api/core.md
      - Analysis: api/analysis.md
      - Cheminformatics: api/chem.md
      - Plots: api/plots.md
      - Preparation: api/prep.md
      - Constants: api/constants.md
  - Resources: resources.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - toc:
      permalink: true