ZEPHYRUS/mkdocs.yml at main · FormingWorlds/ZEPHYRUS · 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
site_name: ZEPHYRUS
site_url: https://proteus-framework.org/ZEPHYRUS/
repo_url: https://github.com/FormingWorlds/ZEPHYRUS
repo_name: GitHub

nav:
  - Home: index.md
  - Contributing: CONTRIBUTING.md
  - Code of Conduct: CODE_OF_CONDUCT.md
  - Source code: https://github.com/FormingWorlds/ZEPHYRUS
  - Issues page: https://github.com/FormingWorlds/ZEPHYRUS/issues
  - 🔗 PROTEUS: https://proteus-framework.org/PROTEUS/
  - 🔗 JANUS: https://proteus-framework.org/JANUS/
  - 🔗 CALLIOPE: https://proteus-framework.org/CALLIOPE/
  - 🔗 AGNI: https://www.h-nicholls.space/AGNI/
  - 🔗 Obliqua: https://proteus-framework.org/Obliqua/
  - 🔗 VULCAN: https://proteus-framework/VULCAN/
  - 🔗 Zalmoxis: https://proteus-framework.org/Zalmoxis/
  - 🔗 Aragog: https://proteus-framework.org/aragog/
  - 🔗 SPIDER: https://github.com/djbower/spider
  - 🔗 Atmodeller: https://atmodeller.readthedocs.io/en/latest/
  - 🔗 FastChem: https://newstrangeworlds.github.io/FastChem/
  - 🔗 PLATON: https://platon.readthedocs.io/en/latest/

theme:
  name: material
  custom_dir: docs/overrides

  # Default assets (used unless overridden per palette below)
  favicon: logo/PROTEUS_black_on_white_logo_only.png
  logo: logo/PROTEUS_white_on_black.png

  palette:
    # Auto: follow system preference (and show a toggle)
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: deep orange
      favicon: logo/PROTEUS_black_on_white_logo_only.png
      logo: logo/PROTEUS_white_on_black.png
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      favicon: logo/PROTEUS_white_on_black_logo_only.png
      logo: logo/PROTEUS_white_on_black.png
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - markdown_include.include:
      base_path: docs
  - pymdownx.extra
  - pymdownx.arithmatex:
      generic: true

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

plugins:
- search
- mkdocstrings:
    # https://mkdocstrings.github.io/usage/
    handlers:
      python:
        paths: [src]
        inventories:
        - https://installer.readthedocs.io/en/stable/objects.inv
        - https://numpy.org/doc/stable/objects.inv
        - https://docs.scipy.org/doc/scipy/objects.inv
        - https://pandas.pydata.org/docs/objects.inv
        - https://matplotlib.org/stable/objects.inv
        options:
          docstring_style: numpy
          docstring_options:
            ignore_init_summary: yes
          show_submodules: no
          show_source: true
          show_symbol_type_heading: True
          show_root_heading: true
          show_root_toc_entry: true
          show_docstring_attributes: true
          show_root_full_path: false
          docstring_section_style: list
          members_order: alphabetical
          merge_init_into_class: yes
          filters: ["!^_"]

watch:
  - src/
  - docs/
  - README.md
  - CONTRIBUTING.md
  - CODE_OF_CONDUCT.md