From 7a1adcd68c8f2611219d26b3ad546a1b0e71facb Mon Sep 17 00:00:00 2001 From: Matthieu Date: Mon, 19 Aug 2024 09:18:16 +0200 Subject: [PATCH] ref: awesome-pages -> literate-nav --- docs/.pages | 21 --------------------- docs/SUMMARY.md | 10 ++++++++++ docs/alps/.pages | 4 ---- docs/alps/SUMMARY.md | 3 +++ docs/best_practices/.pages | 2 -- docs/blog/SUMMARY.md | 2 ++ docs/datasets/.pages | 5 ----- docs/datasets/SUMMARY.md | 5 +++++ docs/events/.pages | 8 -------- docs/events/CIUW/.pages | 4 ---- docs/events/CIUW/SUMMARY.md | 2 ++ docs/events/SUMMARY.md | 7 +++++++ docs/events/icon_meetings/.pages | 13 ------------- docs/events/icon_meetings/SUMMARY.md | 11 +++++++++++ docs/models/.pages | 3 --- docs/support/.pages | 2 -- docs/tasks/.pages | 4 ---- docs/tasks/SUMMARY.md | 3 +++ docs/tools/.pages | 10 ---------- docs/tools/SUMMARY.md | 9 +++++++++ mkdocs.yml | 9 ++------- requirements.txt | 4 ++-- 22 files changed, 56 insertions(+), 85 deletions(-) delete mode 100644 docs/.pages create mode 100644 docs/SUMMARY.md delete mode 100644 docs/alps/.pages create mode 100644 docs/alps/SUMMARY.md delete mode 100644 docs/best_practices/.pages create mode 100644 docs/blog/SUMMARY.md delete mode 100644 docs/datasets/.pages create mode 100644 docs/datasets/SUMMARY.md delete mode 100644 docs/events/.pages delete mode 100644 docs/events/CIUW/.pages create mode 100644 docs/events/CIUW/SUMMARY.md create mode 100644 docs/events/SUMMARY.md delete mode 100644 docs/events/icon_meetings/.pages create mode 100644 docs/events/icon_meetings/SUMMARY.md delete mode 100644 docs/models/.pages delete mode 100644 docs/support/.pages delete mode 100644 docs/tasks/.pages create mode 100644 docs/tasks/SUMMARY.md delete mode 100644 docs/tools/.pages create mode 100644 docs/tools/SUMMARY.md diff --git a/docs/.pages b/docs/.pages deleted file mode 100644 index 9cd26415..00000000 --- a/docs/.pages +++ /dev/null @@ -1,21 +0,0 @@ -nav: - - Home: - - index.md - - News: - - blog - - Events: - - events - - Tasks: - - tasks - - User Support: - - support - - Alps: - - alps - - Models: - - models - - Tools: - - tools - - Datasets: - - datasets - - Best Practices: - - best_practices \ No newline at end of file diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 00000000..49fe6d12 --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,10 @@ +* [Home](index.md) +* [News](blog/) +* [Events](events/) +* [Tasks](tasks/) +* [User Support](support/) +* [Alps](alps/) +* [Models](models/) +* [Tools](tools/) +* [Datasets](datasets/) +* [Best Practices](best_practices/) diff --git a/docs/alps/.pages b/docs/alps/.pages deleted file mode 100644 index c6e725c3..00000000 --- a/docs/alps/.pages +++ /dev/null @@ -1,4 +0,0 @@ -nav: - - Alps Infrastructure: index.md - - Supported vClusters: vclusters.md - - User Environments: uenvs.md diff --git a/docs/alps/SUMMARY.md b/docs/alps/SUMMARY.md new file mode 100644 index 00000000..c404ea9a --- /dev/null +++ b/docs/alps/SUMMARY.md @@ -0,0 +1,3 @@ +* [Alps Infrastructure](index.md) +* [Supported vClusters](vclusters.md) +* [User Environments](uenvs.md) diff --git a/docs/best_practices/.pages b/docs/best_practices/.pages deleted file mode 100644 index 678e656a..00000000 --- a/docs/best_practices/.pages +++ /dev/null @@ -1,2 +0,0 @@ -nav: - - ... \ No newline at end of file diff --git a/docs/blog/SUMMARY.md b/docs/blog/SUMMARY.md new file mode 100644 index 00000000..63eeadeb --- /dev/null +++ b/docs/blog/SUMMARY.md @@ -0,0 +1,2 @@ +* [News](index.md) + diff --git a/docs/datasets/.pages b/docs/datasets/.pages deleted file mode 100644 index 38ea761b..00000000 --- a/docs/datasets/.pages +++ /dev/null @@ -1,5 +0,0 @@ -nav: - - Datasets: index.md - - Climate Model Data: climate_model_data.md - - Observational and Re-analysis Datasets: obs_reanalysis_data.md - - CORDEX-FPSCONV Data: cordex_fpsconv_data.md \ No newline at end of file diff --git a/docs/datasets/SUMMARY.md b/docs/datasets/SUMMARY.md new file mode 100644 index 00000000..8be1d9f9 --- /dev/null +++ b/docs/datasets/SUMMARY.md @@ -0,0 +1,5 @@ +* [Datasets](index.md) +* [Climate Model Data](climate_model_data.md) +* [Observational and Re-analysis Datasets](obs_reanalysis_data.md) +* [CORDEX-FPSCONV Data](cordex_fpsconv_data.md) + diff --git a/docs/events/.pages b/docs/events/.pages deleted file mode 100644 index e9bb2c7f..00000000 --- a/docs/events/.pages +++ /dev/null @@ -1,8 +0,0 @@ -title: Events -nav: - - index.md - - ICON Meeting: icon_meetings - - COSMO/ICON User Workshop: CIUW - - Git Courses: git_courses.md - - Python Visualisation Course: pyvis.md - - Climte Model and Data Workshop: climate_model_workshop.md diff --git a/docs/events/CIUW/.pages b/docs/events/CIUW/.pages deleted file mode 100644 index 2c7fe1d1..00000000 --- a/docs/events/CIUW/.pages +++ /dev/null @@ -1,4 +0,0 @@ -nav: - - index.md - - "2024": 2024.md -order: desc \ No newline at end of file diff --git a/docs/events/CIUW/SUMMARY.md b/docs/events/CIUW/SUMMARY.md new file mode 100644 index 00000000..46fc75de --- /dev/null +++ b/docs/events/CIUW/SUMMARY.md @@ -0,0 +1,2 @@ +* [2024](2024.md) + diff --git a/docs/events/SUMMARY.md b/docs/events/SUMMARY.md new file mode 100644 index 00000000..f9f3fd01 --- /dev/null +++ b/docs/events/SUMMARY.md @@ -0,0 +1,7 @@ +* [Events](index.md) +* [ICON Meeting](icon_meetings/index.md) +* [COSMO/ICON User Workshop](CIUW/index.md) +* [Git Courses](git_courses.md) +* [Python Visualisation Course](pyvis.md) +* [Climte Model and Data Workshop](climate_model_workshop.md) + diff --git a/docs/events/icon_meetings/.pages b/docs/events/icon_meetings/.pages deleted file mode 100644 index d526dbc9..00000000 --- a/docs/events/icon_meetings/.pages +++ /dev/null @@ -1,13 +0,0 @@ -nav: - - index.md - - 2024/2: 2024-2.md - - 2024/1: 2024-1.md - - 2023/4: 2023-4.md - - 2023/3: 2023-3.md - - 2023/2: 2023-2.md - - 2023/1: 2023-1.md - - 2022/4: 2022-4.md - - 2022/3: 2022-3.md - - 2022/2: 2022-2.md - - 2022/1: 2022-1.md -order: desc \ No newline at end of file diff --git a/docs/events/icon_meetings/SUMMARY.md b/docs/events/icon_meetings/SUMMARY.md new file mode 100644 index 00000000..ffcf3886 --- /dev/null +++ b/docs/events/icon_meetings/SUMMARY.md @@ -0,0 +1,11 @@ +* [2024/2](2024-2.md) +* [2024/1](2024-1.md) +* [2023/4](2023-4.md) +* [2023/3](2023-3.md) +* [2023/2](2023-2.md) +* [2023/1](2023-1.md) +* [2022/4](2022-4.md) +* [2022/3](2022-3.md) +* [2022/2](2022-2.md) +* [2022/1](2022-1.md) + diff --git a/docs/models/.pages b/docs/models/.pages deleted file mode 100644 index 303457c6..00000000 --- a/docs/models/.pages +++ /dev/null @@ -1,3 +0,0 @@ -nav: - - ... -order: desc \ No newline at end of file diff --git a/docs/support/.pages b/docs/support/.pages deleted file mode 100644 index 678e656a..00000000 --- a/docs/support/.pages +++ /dev/null @@ -1,2 +0,0 @@ -nav: - - ... \ No newline at end of file diff --git a/docs/tasks/.pages b/docs/tasks/.pages deleted file mode 100644 index 69002a85..00000000 --- a/docs/tasks/.pages +++ /dev/null @@ -1,4 +0,0 @@ -nav: - - index.md - - Working Groups: working_groups.md - - Task Assignment: assignment.md \ No newline at end of file diff --git a/docs/tasks/SUMMARY.md b/docs/tasks/SUMMARY.md new file mode 100644 index 00000000..567a5cce --- /dev/null +++ b/docs/tasks/SUMMARY.md @@ -0,0 +1,3 @@ +* [Working Groups](working_groups.md) +* [Task Assignment](assignment.md) + diff --git a/docs/tools/.pages b/docs/tools/.pages deleted file mode 100644 index 1e9e3dc8..00000000 --- a/docs/tools/.pages +++ /dev/null @@ -1,10 +0,0 @@ -nav: - - index.md - - DWD ICON Tools: icontools.md - - EXTPAR: extpar.md - - icon-vis: icon-vis.md - - INT2LM: int2lm.md - - Processing Chain: processing_chain.md - - Scaling Analysis: scaling_analysis.md - - SPICE: spice.md - - Zephyr: zephyr.md \ No newline at end of file diff --git a/docs/tools/SUMMARY.md b/docs/tools/SUMMARY.md new file mode 100644 index 00000000..2399ec1f --- /dev/null +++ b/docs/tools/SUMMARY.md @@ -0,0 +1,9 @@ +* [Tools](index.md) +* [DWD ICON Tools](icontools.md) +* [EXTPAR](extpar.md) +* [icon-vis](icon-vis.md) +* [INT2LM](int2lm.md) +* [Processing Chain](processing_chain.md) +* [Scaling Analysis](scaling_analysis.md) +* [SPICE](spice.md) +* [Zephyr](zephyr.md) diff --git a/mkdocs.yml b/mkdocs.yml index d4070a2e..b51646a9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -48,13 +48,8 @@ markdown_extensions: permalink: true plugins: - search - - awesome-pages: - filename: .pages - collapse_single_pages: true - strict: false - order: asc - sort_type: natural - order_by: title + - literate-nav: + nav_file: SUMMARY.md - blog extra_css: - stylesheets/extra.css diff --git a/requirements.txt b/requirements.txt index 02958c31..5662e625 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ mkdocs mkdocs-material -mkdocs-awesome-pages-plugin -mkdocs-linkcheck \ No newline at end of file +mkdocs-literate-nav +mkdocs-linkcheck