KnightShock/mkdocs.yml at main · mpierro3/KnightShock · 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
site_name: KnightShock
repo_name: VasuLab/KnightShock
repo_url: https://github.com/VasuLab/KnightShock
edit_uri: ""

nav:
  - Overview:
    - index.md
    - License: license.md
  - Examples:
    - Planning:
      - Absorption: examples/planning/absorption.ipynb
  - Reference:
    - Constants: reference/constants.md
    - Absorption: reference/absorption.md
    - Kinetics: reference/kinetics.md
    - Figures: reference/figures.md

theme:
  name: material
  palette:
    scheme: slate
    primary: amber
    accent: yellow
  features:
    - navigation.indexes
    - navigation.tabs
    - navigation.sections
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tilde
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

plugins:
  - mkdocs-jupyter:
      theme: dark
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: false
            show_root_toc_entry: false
            members_order: source
            docstring_section_style: list
            merge_init_into_class: true
            filters:
              - "!^_"  # exclude all members starting with _
              - "^__init__$"  # but always include __init__ modules and methods
  - search
  - tags

watch:
  - knightshock

extra_css:
  - stylesheets/extra.css

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