From e5b62514ba9889dac0e980af77207b0e2e749b85 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Wed, 23 Aug 2023 12:22:38 +0200
Subject: [PATCH] initial move to mkdocs, lots of broken stuff to fix still
Signed-off-by: Karel van Klink <karel.vanklink@geant.org>
---
.gitignore | 5 ++--
.gitlab-ci.yml | 12 ++++++++
docs/Makefile | 20 --------------
.../Legacy_GAP_diagrams.overview.drawio.png | Bin
.../images}/WFO_deploy_router.png | Bin
.../images}/access_port_diagram.png | Bin
.../images}/geant_ip_ports_diagram.png | Bin
.../images}/geant_logo_white.svg | 0
.../.$Legacy_GAP_diagrams.drawio.bkp | 0
.../image_sources/Legacy_GAP_diagrams.drawio | 0
docs/assets/stylesheets/extra.css | 5 ++++
docs/static/custom.css | 3 --
mkdocs.yml | 26 ++++++++++++++++++
..._documentation.sh => test_documentation.sh | 0
{docs/vale => vale}/.vale.ini | 0
.../styles/Vocab/Sphinx/accept.txt | 0
.../styles/Vocab/geant-jargon/accept.txt | 0
17 files changed, 46 insertions(+), 25 deletions(-)
delete mode 100644 docs/Makefile
rename docs/{static => assets/images}/Legacy_GAP_diagrams.overview.drawio.png (100%)
rename docs/{static => assets/images}/WFO_deploy_router.png (100%)
rename docs/{static => assets/images}/access_port_diagram.png (100%)
rename docs/{static => assets/images}/geant_ip_ports_diagram.png (100%)
rename docs/{static => assets/images}/geant_logo_white.svg (100%)
rename docs/{static => assets/images}/image_sources/.$Legacy_GAP_diagrams.drawio.bkp (100%)
rename docs/{static => assets/images}/image_sources/Legacy_GAP_diagrams.drawio (100%)
create mode 100644 docs/assets/stylesheets/extra.css
delete mode 100644 docs/static/custom.css
create mode 100644 mkdocs.yml
rename docs/test_documentation.sh => test_documentation.sh (100%)
rename {docs/vale => vale}/.vale.ini (100%)
rename {docs/vale => vale}/styles/Vocab/Sphinx/accept.txt (100%)
rename {docs/vale => vale}/styles/Vocab/geant-jargon/accept.txt (100%)
diff --git a/.gitignore b/.gitignore
index 50e7887..53285fe 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,5 +6,6 @@ venv/
# Documentation
docs/build
-docs/vale/styles/*
-!docs/vale/styles/Vocab/
+vale/styles/*
+!vale/styles/Vocab/
+site/
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 84755f9..7e93caa 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -6,3 +6,15 @@ stages:
include:
# Documentation pipelines, both building and linting
- local: '/docs/.gitlab-ci.yml'
+
+#image: python:latest
+#pages:
+# stage: deploy
+# script:
+# - pip install mkdocs-material
+# - mkdocs build --site-dir public
+# artifacts:
+# paths:
+# - public
+# rules:
+# - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100644
index ed88099..0000000
--- a/docs/Makefile
+++ /dev/null
@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS ?=
-SPHINXBUILD ?= sphinx-build
-SOURCEDIR = .
-BUILDDIR = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
- @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/static/Legacy_GAP_diagrams.overview.drawio.png b/docs/assets/images/Legacy_GAP_diagrams.overview.drawio.png
similarity index 100%
rename from docs/static/Legacy_GAP_diagrams.overview.drawio.png
rename to docs/assets/images/Legacy_GAP_diagrams.overview.drawio.png
diff --git a/docs/static/WFO_deploy_router.png b/docs/assets/images/WFO_deploy_router.png
similarity index 100%
rename from docs/static/WFO_deploy_router.png
rename to docs/assets/images/WFO_deploy_router.png
diff --git a/docs/static/access_port_diagram.png b/docs/assets/images/access_port_diagram.png
similarity index 100%
rename from docs/static/access_port_diagram.png
rename to docs/assets/images/access_port_diagram.png
diff --git a/docs/static/geant_ip_ports_diagram.png b/docs/assets/images/geant_ip_ports_diagram.png
similarity index 100%
rename from docs/static/geant_ip_ports_diagram.png
rename to docs/assets/images/geant_ip_ports_diagram.png
diff --git a/docs/static/geant_logo_white.svg b/docs/assets/images/geant_logo_white.svg
similarity index 100%
rename from docs/static/geant_logo_white.svg
rename to docs/assets/images/geant_logo_white.svg
diff --git a/docs/static/image_sources/.$Legacy_GAP_diagrams.drawio.bkp b/docs/assets/images/image_sources/.$Legacy_GAP_diagrams.drawio.bkp
similarity index 100%
rename from docs/static/image_sources/.$Legacy_GAP_diagrams.drawio.bkp
rename to docs/assets/images/image_sources/.$Legacy_GAP_diagrams.drawio.bkp
diff --git a/docs/static/image_sources/Legacy_GAP_diagrams.drawio b/docs/assets/images/image_sources/Legacy_GAP_diagrams.drawio
similarity index 100%
rename from docs/static/image_sources/Legacy_GAP_diagrams.drawio
rename to docs/assets/images/image_sources/Legacy_GAP_diagrams.drawio
diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css
new file mode 100644
index 0000000..f61e8d8
--- /dev/null
+++ b/docs/assets/stylesheets/extra.css
@@ -0,0 +1,5 @@
+:root {
+ --md-primary-fg-color: #EE0F0F;
+ --md-primary-fg-color--light: #ECB7B7;
+ --md-primary-fg-color--dark: #90030C;
+}
diff --git a/docs/static/custom.css b/docs/static/custom.css
deleted file mode 100644
index 7297b93..0000000
--- a/docs/static/custom.css
+++ /dev/null
@@ -1,3 +0,0 @@
-.wy-menu > p > span {
- color: rgb(237 21 86);
-}
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..6cf1c93
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,26 @@
+# General
+site_name: Geant Automation Platform
+site_url: https://docs.gap.geant.org/
+site_author: GÉANT Orchestration and Automation Team
+site_description: General documentation for the GÉANT Automation Platform
+
+# Repository
+repo_name: goat/gap/geant-automation-platform
+repo_url: https://gitlab.software.geant.org/goat/gap/geant-automation-platform
+
+# Theme
+theme:
+ name: material
+ palette:
+ primary: custom
+extra_css:
+ - static/stylesheets/extra.css
+
+# Page tree
+nav:
+ - Home: index.md
+ - Architecture:
+ - Overview: overview/index.md
+ - Modeling:
+ - modeling/index.md
+ - Ports: modeling/ports.md
diff --git a/docs/test_documentation.sh b/test_documentation.sh
similarity index 100%
rename from docs/test_documentation.sh
rename to test_documentation.sh
diff --git a/docs/vale/.vale.ini b/vale/.vale.ini
similarity index 100%
rename from docs/vale/.vale.ini
rename to vale/.vale.ini
diff --git a/docs/vale/styles/Vocab/Sphinx/accept.txt b/vale/styles/Vocab/Sphinx/accept.txt
similarity index 100%
rename from docs/vale/styles/Vocab/Sphinx/accept.txt
rename to vale/styles/Vocab/Sphinx/accept.txt
diff --git a/docs/vale/styles/Vocab/geant-jargon/accept.txt b/vale/styles/Vocab/geant-jargon/accept.txt
similarity index 100%
rename from docs/vale/styles/Vocab/geant-jargon/accept.txt
rename to vale/styles/Vocab/geant-jargon/accept.txt
--
GitLab