PyPSA-China-PIK/mkdocs.yml at main · irr-github/PyPSA-China-PIK · 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

site_name: PyPSA China (PIK) #(PIK edition) Documentation
site_url: https://pik-piam.github.io/PyPSA-China-PIK/
repo_url: https://github.com/pik-piam/PyPSA-China-PIK
repo_name: pik-piam/PyPSA-China-PIK

theme:
  name: "material"
  logo: "assets/img/logo_small.png"
  favicon: "assets/img/pypsa_china.ico"
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    # - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - navigation.footer
  language: en
  palette:
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
      primary: black
      accent: amber
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
      # primary: deep purple
      accent: blue

docs_dir: "./docs"
nav:
  - .nav.yml
  # - tutorials/.nav.yml

# Version configuration and social links
extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pik-piam/PyPSA-China-PIK
      name: PyPSA-China-PIK on GitHub

# Due to snakemake workflow, we need to include the 'scripts' directory in the python path
plugins:
  - search
  - gen-files:
      scripts:
      - docs/autogen_ref_pages.py
  - awesome-nav
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: ["./workflow/scripts"]

extra_css:
  - docs/assets/styles/extra.css
extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS-MML_HTMLorMML
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - mdx_math

copyright: &copy Potsdam Institute for Climate Impact Research (PIK) 2024