AntaREST/mkdocs.yml at dev · AntaresSimulatorTeam/AntaREST · 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
docs_dir: docs
site_name: Antares Web Documentation
repo_name: AntaREST
repo_url: https://github.com/AntaresSimulatorTeam/AntaREST
edit_uri: edit/dev/docs

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  prev_next_buttons_location: none
  features:
    - navigation.instant
    - navigation.top
    - content.action.edit
    - content.action.view
  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

nav:
  - Home: index.md
  - Build from source: installation.md
  - Configuration: configuration.md
  - Deployment: deploy.md
  - Architecture: architecture.md
  - Database management: database.md
  - Add a new study version: add-new-antares-version.md
  - Changelog: CHANGELOG.md
  - Contributing: contributing.md

extra:
  generator: false
  version:
    provider: mike
plugins:
  - search

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - attr_list
  - toc:
      permalink: true
      toc_depth: 4
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true

copyright: Copyright &copy; 2007 - 2026 RTE