GemsPy/mkdocs.yml at main · AntaresSimulatorTeam/GemsPy · 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
site_name: GemsPy - a Python interpreter for GEMS
repo_url: https://github.com/AntaresSimulatorTeam/GemsPy
nav:
  - 'Home': 'index.md'
  - 'Getting started': 'getting-started.md'
  - 'User guide: GEMS language and data structure': 'user-guide.md'
  - 'User guide: GemsPy interpreter package':
    - 'Reading input files': 'user-guide/inputs.md'
    - 'Building systems with the Python API': 'user-guide/building.md'
    - 'Optimization: building and solving problems': 'user-guide/optimisation.md'
    - 'Retrieving outputs': 'user-guide/outputs.md'
    - 'Data converters': 'user-guide/converters.md'
  - Developer guide: developer-guide.md
  - Changelog: CHANGELOG.md

theme:
  name: material
  logo: images/logo.png
  favicon: images/logo.png
  prev_next_buttons_location: none
  features:
    - navigation.instant
    - navigation.top
    - content.tabs.link
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: antares
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [ src ]
          options:
            show_bases: false
            show_source: false

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences