-
Notifications
You must be signed in to change notification settings - Fork 24
/
mkdocs.yml
118 lines (110 loc) · 4.8 KB
/
mkdocs.yml
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
docs_dir: docs
site_name: Antares Simulator Documentation
repo_url: https://github.com/AntaresSimulatorTeam/Antares_Simulator
edit_uri: edit/doc/docs/
theme:
name: material
logo: assets/logo.png
favicon: assets/Icone.png
prev_next_buttons_location: none
custom_dir: docs/overrides
features:
- navigation.instant
- navigation.top
- content.tabs.link
# - navigation.expand
# - navigation.sections
# - header.autohide
# - toc.separate
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'
- 'User guide':
- 'Overview': 'user-guide/01-overview.md'
- 'Installation': 'user-guide/02-install.md'
- 'Getting started': 'user-guide/03-getting_started.md'
- 'Solver':
- 'Overview': 'user-guide/solver/01-overview.md'
- 'Input files': 'user-guide/solver/02-inputs.md'
- 'Output files': 'user-guide/solver/03-outputs.md'
- 'Parameters': 'user-guide/solver/04-parameters.md'
- 'Optimization model': 'user-guide/solver/05-model.md'
- 'Hydro heuristics': 'user-guide/solver/06-hydro-heuristics.md'
- 'Thermal heuristics': 'user-guide/solver/07-thermal-heuristic.md'
- 'Command-line instructions': 'user-guide/solver/08-command-line.md'
- 'Optional features':
- 'Multi-threading': 'user-guide/solver/optional-features/multi-threading.md'
- 'Adequacy patch': 'user-guide/solver/optional-features/adequacy-patch.md'
- 'Usage with FICO® Xpress Optimizer': 'user-guide/solver/optional-features/xpress.md'
- 'Appendix': 'user-guide/solver/09-appendix.md'
- 'Time-series generation':
- 'Overview': 'user-guide/ts-generator/01-overview.md'
- 'Input files': 'user-guide/ts-generator/02-inputs.md'
- 'Output files': 'user-guide/ts-generator/03-outputs.md'
- 'Parameters': 'user-guide/ts-generator/04-parameters.md'
- 'Algorithm': 'user-guide/ts-generator/05-algorithm.md'
- 'Command-line instructions': 'user-guide/ts-generator/06-command-line.md'
- 'Other features':
- 'Batch Runner': 'user-guide/other-features/batchrun.md'
- 'Config Checker': 'user-guide/other-features/config.md'
- 'GUI': 'user-guide/other-features/ui-simulator.md'
- 'Kirchhoff''s constraint generator': 'user-guide/other-features/kirchhoff-constraints-builder.md'
- 'Study Cleaner': 'user-guide/other-features/study-cleaner.md'
- 'Study Finder': 'user-guide/other-features/study-finder.md'
- 'Study Updater': 'user-guide/other-features/study-updater.md'
- 'Time-Series Analyzer': 'user-guide/other-features/analyzer.md'
- 'Vacuum': 'user-guide/other-features/vacuum.md'
- 'Year-by-Year Aggregator': 'user-guide/other-features/ybyaggregator.md'
- 'Migration guides': 'user-guide/04-migration-guides.md'
- 'Attribution notices': 'user-guide/05-attribution_notices.md'
- 'Developer guide':
- 'Overview': 'developer-guide/0-Overview.md'
- 'Development requirements': 'developer-guide/1-Development-requirements.md'
- 'Dependencies install': 'developer-guide/2-Dependencies-install.md'
- 'Build': 'developer-guide/3-Build.md'
- 'Tests (user)': 'developer-guide/4-Tests-user.md'
- 'Tests (developer)': 'developer-guide/4-Tests-dev.md'
- 'Installer creation': 'developer-guide/5-Installer-creation.md'
- 'Contributing': 'developer-guide/6-Contributing.md'
- 'Continuous Integration': 'developer-guide/continuous-integration.md'
- 'OR-tools integration': 'developer-guide/ortools-integration.md'
- 'Changelog': 'developer-guide/CHANGELOG.md'
- 'External links':
- 'Antares ecosystem': 'https://antares-doc.readthedocs.io'
- 'Antares website': 'https://antares-simulator.org'
- 'RTE website': 'http://www.rte-france.com/'
- 'Contact': 'https://github.com/AntaresSimulatorTeam/Antares_Simulator/issues/new?template=support_request.md'
plugins:
- search
extra_css:
- stylesheets/extra.css
extra_javascript:
- https://code.jquery.com/jquery-3.6.0.min.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- javascripts/mathjax.js
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js
markdown_extensions:
- footnotes
- attr_list
- toc:
permalink: true
toc_depth: 3
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
copyright: Copyright © 2007 - 2024 RTE