fluxopt/mkdocs.yml at main · FBumann/fluxopt · 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
site_name: fluxopt
site_description: Energy system optimization with linopy
repo_url: https://github.com/FBumann/fluxopt
repo_name: FBumann/fluxopt

nav:
  - Home: index.md
  - Notebooks:
    - Quickstart: notebooks/01-quickstart.ipynb
    - Heat System: notebooks/02-heat-system.ipynb
    - Multi-Node Heat: notebooks/03-multi-node-heat.ipynb
    - Multi-Period: notebooks/04-multi-period.ipynb
    - Investment: notebooks/05-investment.ipynb
    - Status: notebooks/06-status.ipynb
  - Math:
    - Notation: math/notation.md
    - Objective: math/objective.md
    - Carrier Balance: math/carrier-balance.md
    - Flows: math/flows.md
    - Converters: math/converters.md
    - Storage: math/storage.md
    - Effects: math/effects.md
    - Sizing: math/sizing.md
    - Status: math/status.md
  - API Reference: api/
  - Changelog: changelog.md

theme:
  name: material
  language: en

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  font:
    text: Roboto
    code: Fira Code

  icon:
    repo: fontawesome/brands/github

  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.select

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - include-markdown

  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py

  - literate-nav:
      nav_file: SUMMARY.md

  - mkdocs-jupyter:
      include_source: true
      execute: true
      remove_tag_config:
        remove_input_tags: ["hide-input"]

  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_section_style: table
            members_order: source
            show_if_no_docstring: false
            heading_level: 1
            show_root_heading: true
            show_signature: true
            show_signature_annotations: true
            separate_signature: true
            line_length: 80
            modernize_annotations: true
            merge_init_into_class: true

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

watch:
  - src/fluxopt
  - docs