femto/mkdocs.yml at main · Psivant/femto · 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
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: "femto"
site_description: "A comprehensive toolkit for predicting free energies."
site_url: "https://github.com/psivant/femto"
repo_url: "https://github.com/psivant/femto"
repo_name: "psivant/femto"
site_dir: "site"
watch: [mkdocs.yml, README.md, femto/, docs]
copyright: Copyright &copy; 2023 Psivant Therapeutics, Simon Boothroyd
edit_uri: edit/main/docs/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

extra:
  version:
    provider: mike

nav:
- Home:
  - Overview: index.md
- Guide:
  - MD:
    - Overview: guide-md.md
  - FE:
    - Overview: guide-fe.md
    - ATM: guide-atm.md
    - SepTop: guide-septop.md
- API reference: reference/
- Development:
  - Overview: development.md
  - Migration: migration.md

theme:
  name: material
  features:
  - announce.dismiss
  - content.action.edit
  - content.action.view
  - content.code.annotate
  - content.code.copy
  - content.tooltips
  - navigation.footer
  - navigation.indexes
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - search.highlight
  - search.suggest
  - toc.follow
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: teal
    accent: purple
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    accent: lime
    toggle:
      icon: material/weather-night
      name: Switch to light mode

markdown_extensions:
- attr_list
- def_list
- admonition
- footnotes
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.magiclink
- pymdownx.snippets:
    check_paths: true
- pymdownx.details
- pymdownx.arithmatex:
    generic: true
- pymdownx.tabbed:
    alternate_style: true
- toc:
    permalink: "#"

plugins:
- autorefs
- search
- gen-files:
    scripts:
    - docs/scripts/gen_ref_pages.py
- literate-nav:
    nav_file: SUMMARY.md
- mkdocstrings:
    handlers:
      python:
        paths: [femto/]
        import:
          - https://parmed.github.io/ParmEd/html/objects.inv
          - http://docs.openmm.org/latest/api-python/objects.inv
          - https://www.mdtraj.org/1.9.6/objects.inv
          - https://simonboothroyd.github.io/mdtop/latest/objects.inv
        options:
          extensions: [ griffe_pydantic ]
          docstring_options:
            ignore_init_summary: true
            returns_multiple_items: false
            returns_named_value: false
          docstring_section_style: list
          heading_level: 1
          inherited_members: true
          merge_init_into_class: true
          separate_signature: true
          show_root_heading: true
          show_root_full_path: false
          show_signature_annotations: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          signature_crossrefs: true
          summary: true
          members_order: source

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js