From c2db72bbd9af22df06d59d0a6c0293df6e36ad35 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Wed, 4 Dec 2024 16:52:54 +0100 Subject: [PATCH] fix markdown files + add nav --- .gitignore | 1 + docs/community/help.md | 6 +++--- docs/index.md | 8 ++------ docs/reference/api/index.md | 7 ++++--- docs/reference/encodings/index.md | 6 +++--- docs/reference/problem/index.md | 6 +++--- mkdocs.yml | 18 ++++++++++++++++++ 7 files changed, 34 insertions(+), 18 deletions(-) diff --git a/.gitignore b/.gitignore index 59ddbcb..d4ac8b9 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,4 @@ build .coverage _build _autosummary +site diff --git a/docs/community/help.md b/docs/community/help.md index d83119a..4c98225 100644 --- a/docs/community/help.md +++ b/docs/community/help.md @@ -1,6 +1,6 @@ -______________________________________________________________________ - -## icon: material/help-circle +--- +icon: material/help-circle +--- # Help diff --git a/docs/index.md b/docs/index.md index 8206b81..5221cc5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,13 +1,9 @@ -______________________________________________________________________ - -``` +--- title: Home hide: - navigation - toc -``` - -______________________________________________________________________ +--- # fillname diff --git a/docs/reference/api/index.md b/docs/reference/api/index.md index f7110fb..0f84315 100644 --- a/docs/reference/api/index.md +++ b/docs/reference/api/index.md @@ -1,5 +1,6 @@ -______________________________________________________________________ - -## icon: material/book-open-variant +--- +title: "API Reference" +icon: "material/book-open-variant" +--- # API diff --git a/docs/reference/encodings/index.md b/docs/reference/encodings/index.md index a1871b0..fb7f670 100644 --- a/docs/reference/encodings/index.md +++ b/docs/reference/encodings/index.md @@ -1,5 +1,5 @@ -______________________________________________________________________ - -## icon: material/file-code +--- +icon: material/file-code +--- # Encodings diff --git a/docs/reference/problem/index.md b/docs/reference/problem/index.md index a8aa1e9..685afb9 100644 --- a/docs/reference/problem/index.md +++ b/docs/reference/problem/index.md @@ -1,5 +1,5 @@ -______________________________________________________________________ - -## icon: material/head-dots-horizontal +--- +icon: material/head-dots-horizontal +--- # Problem specification diff --git a/mkdocs.yml b/mkdocs.yml index b35060c..0b3d5d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -65,6 +65,7 @@ extra: - icon: potassco-logo link: https://potassco.org generator: false + markdown_extensions: - admonition - pymdownx.details @@ -109,3 +110,20 @@ plugins: show_inherited_detail_toc: true show_inherited_detail_tree: true show_source: false + +nav: + - Home: index.md + - Getting Started: getting_started.md + - Examples: examples/index.md + - Reference: + - reference/index.md + - Problem: reference/problem/index.md + - Encodings: reference/encodings/index.md + - API: reference/api/index.md + - Community: + - community/index.md + - Help: community/help.md + - Changes: community/CHANGES.md + - Contributing: community/CONTRIBUTING.md + - Development: community/DEVELOPMENT.md + - Deployment: community/DEPLOYMENT.md