KOH-GPJax/mkdocs.yml at main · jamesbriant/KOH-GPJax · 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
site_name: "KOH-GPJax"
site_description: "Documentation website for KOH-GPJax"
site_author: "James Briant"
copyright: "Copyright © 2025 James Briant"
repo_url: "https://github.com/jamesbriant/koh-gpjax/"
repo_name: "jamesbriant/KOH-GPJax"
edit_uri: edit/main/docs/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

theme:
  name: "material"
  features:
    - content.action.edit
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top # Show a back to top button
    - content.code.copy
    - search.suggest # Show search suggestions
    - search.highlight # Highlight search results in results
    - content.code.annotate # Allow individual lines of code to be annotated
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - 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 system preference
  icon:
    repo: fontawesome/brands/github

nav:
  - Overview: index.md
  - Installation: installation.md
  # - Getting Started: getting-started.md
  # - Tutorials: tutorials/
  - Examples: _examples/
  - API Reference: api/
  - License: LICENSE.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic : true
  - footnotes


plugins:
  - search
  - gen-files:
      scripts:
        - docs/scripts/gen_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          inventories:
            - "https://docs.python.org/3/objects.inv"
          options:
            docstring_style: google
            docstring_section_style: list
            show_submodules: false
            merge_init_into_class: true
          paths: [kohgpjax]
  - include-markdown:
      opening_tag: "{!"
      closing_tag: "!}"
  # - git-authors

extra:
  social:
    - icon: fontawesome/brands/github
      link: "https://github.com/jamesbriant"


extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css