From c5524871ee21704838f5c89cc24dfc56c5239c3b Mon Sep 17 00:00:00 2001 From: Andrea Sgattoni Date: Thu, 7 Oct 2021 11:28:28 +0200 Subject: [PATCH 1/3] add mkdocs.yml --- mkdocs.yml | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000000..11371bb86d --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,58 @@ +docs_dir: docs +site_name: Antares-Web +repo_url: https://github.com/AntaresSimulatorTeam/AntaREST +edit_uri: edit/doc/docs/ + +theme: + name: material + logo: assets/logo.png + favicon: assets/Icone.png + prev_next_buttons_location: none + features: + - navigation.instant + - navigation.top + - 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 + +extra: + generator: false + version: + provider: mike +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 + - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML + +markdown_extensions: + - 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 + +copyright: Copyright © 2007 - 2021 RTE \ No newline at end of file From 45f8d9ad574ff989d8e34c1f98f8ec833b65687b Mon Sep 17 00:00:00 2001 From: Andrea Sgattoni Date: Thu, 7 Oct 2021 11:34:53 +0200 Subject: [PATCH 2/3] add nav in mkdocs.yml --- mkdocs.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 11371bb86d..b82b7be41a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -55,4 +55,15 @@ markdown_extensions: - pymdownx.superfences - pymdownx.tabbed + +nav: + - 'Home': index.md + - 'Antares ecosystem' : 'https://antares-doc.readthedocs.io' + - 'User guide': + - 'Introduction': 'user-guide/0-introduction.md' + - 'Install': + - 'Introduction': 'install/0-introduction.md' + - 'Changelog': 'CHANGELOG.md' + + copyright: Copyright © 2007 - 2021 RTE \ No newline at end of file From a80355b8a10dc01800a1c4c982188bc84175a997 Mon Sep 17 00:00:00 2001 From: Paul Date: Thu, 7 Oct 2021 21:23:37 +0200 Subject: [PATCH 3/3] Fix readthedocs conf Signed-off-by: Paul --- mkdocs.yml | 69 ------------------------------------------------- readthedocs.yml | 2 +- 2 files changed, 1 insertion(+), 70 deletions(-) delete mode 100644 mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index b82b7be41a..0000000000 --- a/mkdocs.yml +++ /dev/null @@ -1,69 +0,0 @@ -docs_dir: docs -site_name: Antares-Web -repo_url: https://github.com/AntaresSimulatorTeam/AntaREST -edit_uri: edit/doc/docs/ - -theme: - name: material - logo: assets/logo.png - favicon: assets/Icone.png - prev_next_buttons_location: none - features: - - navigation.instant - - navigation.top - - 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 - -extra: - generator: false - version: - provider: mike -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 - - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML - -markdown_extensions: - - 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 - - -nav: - - 'Home': index.md - - 'Antares ecosystem' : 'https://antares-doc.readthedocs.io' - - 'User guide': - - 'Introduction': 'user-guide/0-introduction.md' - - 'Install': - - 'Introduction': 'install/0-introduction.md' - - 'Changelog': 'CHANGELOG.md' - - -copyright: Copyright © 2007 - 2021 RTE \ No newline at end of file diff --git a/readthedocs.yml b/readthedocs.yml index 578cc03846..c7b6332592 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -6,4 +6,4 @@ python: - requirements: requirements-doc.txt mkdocs: - configuration: mkdocs.yml + configuration: docs/mkdocs.yml