tdscha/mkdocs.yml at main · SSCHAcode/tdscha · 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
site_name: TD-SCHA Documentation
site_description: Time-Dependent Self-Consistent Harmonic Approximation
site_url: https://sscha.github.io/tdscha/
repo_url: https://github.com/SSCHAcode/tdscha
repo_name: SSCHAcode/tdscha

# Theme
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - search.suggest
    - content.code.copy

# Markdown extensions
markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true

# Plugins
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [Modules]
          options:
            docstring_style: numpy
            show_root_heading: true
            show_source: true
            merge_init_into_class: true
            filters: ["!^_"]
            members_order: source

# Navigation
nav:
  - Home: index.md
  - Installation: installation.md
  - Quick Start: quickstart.md
  - In-Depth Usage: usage.md
  - StaticHessian: static-hessian.md
  - QSpaceHessian: qspace-hessian.md
  - Kernel Polynomial Method: kpm.md
  - CLI Tools: cli.md
  - API Reference:
    - DynamicalLanczos: api/dynamical_lanczos.md
    - QSpaceLanczos: api/qspace_lanczos.md
    - QSpaceHessian: api/qspace_hessian.md
    - StaticHessian: api/static_hessian.md

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