refactor: removed MkDocs site, preparing for publication via EKGF-for…

…k of the respec repo

.github/workflows/build-spec.yml

@@ -0,0 +1,19 @@
+name: build-spec
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: macos-latest    
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip' # caching pip dependencies
+      - run: pip install -r requirements.txt

.gitignore

@@ -57,5 +57,7 @@ out/
 .idea
 *.fdb_latexmk
 *.xdy
-.venv/
 .pdm-python
+code/bin/
+code/lib/
+code/include

Makefile

@@ -1,226 +1,6 @@
 
-VIRTUAL_ENV := ./.venv
-LANG := en
-
-ifeq ($(OS),Windows_NT)
-	YOUR_OS := Windows
-	INSTALL_TARGET := install-windows
-	SYSTEM_PYTHON := python3
-else
-	YOUR_OS := $(shell sh -c 'uname 2>/dev/null || echo Unknown')
-ifeq ($(YOUR_OS), Linux)
-	INSTALL_TARGET := install-linux
-	ifneq ($(wildcard /home/runner/.*),) # this means we're running in Github Actions
-		PIP := pip
-		SYSTEM_PYTHON := python3
-	else
-		PIP := python3 -m pip
-		SYSTEM_PYTHON := /usr/bin/python3
-	endif
-endif
-ifeq ($(YOUR_OS), Darwin)
-	INSTALL_TARGET := install-macos
-	PIP := python3 -m pip
-	ifneq (,$(wildcard /opt/homebrew/bin/python3))
-		SYSTEM_PYTHON := /opt/homebrew/bin/python3
-	else
-		SYSTEM_PYTHON := /usr/bin/python3
-	endif
-endif
-endif
-
-#
-# Since we do not have asdf for Windows, we need to install these tools
-# on windows in a different way. Here we assume you did that yourself in
-# the local project's virtualenv directory (./.venv).
-#
-ifeq ($(OS),Windows_NT)
-VENV_POETRY := $(VIRTUAL_ENV)/bin/poetry
-VENV_MKDOCS := $(VIRTUAL_ENV)/bin/mkdocs
-VENV_PYTHON := $(VIRTUAL_ENV)/bin/python3
-else # On mac and linux we have asdf:
-  ifneq (,$(wildcard ~/.local/bin/poetry))
-		VENV_POETRY := ~/.local/bin/poetry
-		VENV_MKDOCS := $(VIRTUAL_ENV)/bin/mkdocs
-		VENV_PYTHON := $(VIRTUAL_ENV)/bin/python3
-  else
-		VENV_POETRY := $(shell asdf where poetry)/bin/poetry
-		VENV_MKDOCS := $(VIRTUAL_ENV)/bin/mkdocs
-		VENV_PYTHON := $(VIRTUAL_ENV)/bin/python3
-  endif
-endif
-
-PIPENV_DEFAULT_PYTHON_VERSION := 3.11
-PIPENV_VENV_IN_PROJECT := 1
-
-CURRENT_BRANCH := $(shell git branch --show-current)
-PAT_MKDOCS_INSIDERS := $(shell cat $(HOME)/.secrets/PAT_MKDOCS_INSIDERS.txt 2>/dev/null)
-ifneq ($(PAT_MKDOCS_INSIDERS),)
-MKDOCS_CONFIG_FILE := mkdocs.yml
-else
-$(info You do not have the $(HOME)/.secrets/PAT_MKDOCS_INSIDERS.txt file so we are using the open source version of MkDocs)
-MKDOCS_CONFIG_FILE := mkdocs.outsiders.yml
-endif
-
-.PHONY: all
-all: docs-build
-
-.PHONY: info
-info:
-	@echo "Git Branch        : ${CURRENT_BRANCH}"
-	@echo "Operating System  : ${YOUR_OS}"
-	@echo "MkDocs            : ${VENV_MKDOCS}"
-	@echo "MkDocs config file: ${MKDOCS_CONFIG_FILE}"
-	@echo "System Python     : ${SYSTEM_PYTHON} version: $$($(SYSTEM_PYTHON) --version)" 
-	@echo "Virtual Env Python: ${VENV_PYTHON} version: $$($(VENV_PYTHON) --version)"
-	@echo "Python poetry     : ${VENV_POETRY}"
-	@echo "install target    : ${INSTALL_TARGET}"
-
-.PHONY: clean
-clean:
-	@echo Cleaning
-	@rm -rf site 2>/dev/null || true
-	@rm -rf .venv/lib/python*/site-packages 2>/dev/null || true
-
-.PHONY: install
-install: docs-install
-
-.PHONY: docs-install
-docs-install: info docs-install-brew docs-install-brew-packages docs-install-python-packages
-
-.PHONY: docs-install-github-actions
-docs-install-github-actions: info docs-install-brew-packages docs-install-python-packages
-
-.PHONY: docs-install-brew-packages
-docs-install-brew-packages:
-	@echo "Install packages via HomeBrew:"
-	@brew upgrade cairo 2>/dev/null || brew install cairo
-	@brew upgrade freetype 2>/dev/null || brew install freetype
-	@brew upgrade libffi 2>/dev/null || brew install libffi
-	@brew upgrade pango 2>/dev/null || brew install pango
-	@brew upgrade libjpeg 2>/dev/null || brew install libjpeg
-	@brew upgrade libpng 2>/dev/null || brew install libpng
-	@brew upgrade zlib 2>/dev/null || brew install zlib
-	@brew upgrade plantuml 2>/dev/null || brew install plantuml
-	@brew upgrade graphviz 2>/dev/null || brew install graphviz
-	@brew upgrade pdm 2>/dev/null || brew install pdm
-
-.PHONY: docs-install-brew
-ifeq ($(YOUR_OS), Linux)
-docs-install-brew: docs-install-brew-linux
-endif
-ifeq ($(YOUR_OS), Windows)
-docs-install-brew: docs-install-brew-windows
-endif
-ifeq ($(YOUR_OS), Darwin)
-docs-install-brew: docs-install-brew-macos
-endif
-
-.PHONY: docs-install-brew-linux
-docs-install-brew-linux:
-	@if ! command -v brew >/dev/null 2>&1 ; then echo "Install HomeBrew" ; exit 1 ; fi
-	brew --version
-
-#
-# not sure if HomeBrew can be installed on Windows, this part has not been tested yet!
-#
-.PHONY: docs-install-brew-windows
-docs-install-brew-windows:
-	@if ! command -v brew >/dev/null 2>&1 ; then echo "Install HomeBrew" ; exit 1 ; fi
-	brew --version
-
-.PHONY: docs-install-brew-macos
-docs-install-brew-macos:
-	@if ! command -v brew >/dev/null 2>&1 ; then echo "Install HomeBrew" ; exit 1 ; fi
-	@brew --version
-
-.PHONY: docs-install-asdf
-docs-install-asdf: docs-install-brew
-	@echo "Install the asdf package manager:"
-	@brew upgrade asdf 2>/dev/null || brew install asdf
-	@asdf plugin add python 2>/dev/null || true
-	@asdf plugin add nodejs 2>/dev/null || true
-	@asdf plugin add java 2>/dev/null || true
-	@asdf plugin add poetry https://github.com/asdf-community/asdf-poetry.git 2>/dev/null || true
-
-.PHONY: docs-install-asdf-packages
-docs-install-asdf-packages: docs-install-asdf
-	@echo "Install packages via asdf:"
-	asdf install
-
-# poetry gets installed via asdf
-$(VENV_POETRY): docs-install-asdf-packages
-	@echo $@
-
-.PHONY: docs-install-python-packages
-#ifneq ($(wildcard /home/runner/.*),)
-#docs-install-python-packages: docs-install-asdf
-#else
-docs-install-python-packages: docs-install-asdf-packages docs-install-standard-python-packages docs-install-special-python-packages
-#endif
-
-.PHONY: docs-install-standard-python-packages
-docs-install-standard-python-packages: $(VENV_POETRY)
-	@echo "Install standard python packages via pip:"
-	$(VENV_POETRY) config virtualenvs.in-project true --local
-	$(VENV_POETRY) config experimental.system-git-client true --local
-
-.PHONY: docs-install-special-python-packages
-docs-install-special-python-packages: docs-install-ekglib docs-install-mkdocs-insider-version-packages
-
-.PHONY: docs-install-ekglib
-docs-install-ekglib: $(VENV_POETRY)
-	@echo "Install ekglib via poetry:"
-	$(VENV_POETRY) add "git+https://github.com/EKGF/ekglib.git"
-
-.PHONY: docs-install-mkdocs-insider-version-packages
-docs-install-mkdocs-insider-version-packages: $(VENV_POETRY)
-ifeq ($(PAT_MKDOCS_INSIDERS),)
-	@echo "Install standard mkdocs python package via poetry:"
-	@$(VENV_POETRY) add mkdocs-material
-else
-	@if ! cat poetry.lock | grep -q "mkdocs-material-insiders" ; then \
-		echo "Install special insiders version of mkdocs python package via poetry:" ;\
-		echo "First remove the public version of mkdocs-material, if it's installed:" ;\
-		$(VENV_POETRY) remove mkdocs-material || true ;\
-		echo "Then install the actual insiders version:" ;\
-		$(VENV_POETRY) add -- "git+https://$(PAT_MKDOCS_INSIDERS)@github.com/squidfunk/mkdocs-material-insiders.git" && \
-		echo "Insider's version of mkdocs-material has been installed successfully!" ;\
-	fi
-endif
-
-$(VENV_MKDOCS): docs-install-python-packages
-	@if [ -f $(VENV_MKDOCS) ] ; then echo $(VENV_MKDOCS) exists ; exit 0 ; else echo $(VENV_MKDOCS) does not exist ; exit 1 ; fi
-
-.PHONY: docs-build
-docs-build: $(VENV_MKDOCS)
-	$(VENV_MKDOCS) build --config-file $(MKDOCS_CONFIG_FILE)
-
-.PHONY: docs-build-clean
-docs-build-clean:
-	$(VENV_MKDOCS) build --config-file $(MKDOCS_CONFIG_FILE) --clean
-
-.PHONY: docs-serve
-docs-serve: $(VENV_MKDOCS)
-	$(VENV_MKDOCS) serve --config-file $(MKDOCS_CONFIG_FILE) --livereload --strict
-
-.PHONY: docs-serve-fast
-docs-serve-fast:
-	$(VENV_MKDOCS) serve --config-file $(MKDOCS_CONFIG_FILE) --livereload --strict
-
-.PHONY: docs-serve-non-strict
-docs-serve-non-strict: $(VENV_MKDOCS)
-	$(VENV_MKDOCS) serve --config-file $(MKDOCS_CONFIG_FILE) --livereload
-
-.PHONY: docs-serve-debug
-docs-serve-debug: $(VENV_MKDOCS)
-	$(VENV_MKDOCS) serve --config-file $(MKDOCS_CONFIG_FILE) --livereload --verbose --strict
-
-.PHONY: docs-serve-debug-non-strict
-docs-serve-debug-non-strict: $(VENV_MKDOCS)
-	$(VENV_MKDOCS) serve --config-file $(MKDOCS_CONFIG_FILE) --livereload --verbose
-
-.PHONY: docs-deploy
-docs-deploy: $(VENV_MKDOCS)
-	$(VENV_MKDOCS) gh-deploy --config-file $(MKDOCS_CONFIG_FILE) --verbose
-
+build:
+	python3 -m venv .venv
+	source .venv/bin/activate ; python3 -m pip install --upgrade pip
+	source .venv/bin/activate ; python3 -m pip install -r requirements.txt
+	source .venv/bin/activate ; python3 spec-generator.py

build.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+#
+# Execute this from your document repo's root
+#
+REPO_DIR="$(dirname $(realpath ${BASH_SOURCE[0]}))"
+dist_dir="${REPO_DIR}/assets"
+venv_dir="${REPO_DIR}/.venv"
+system_python_bin="/usr/bin/python3"
+venv_python_bin="${venv_dir}/bin/python3"
+
+function setup() {
+
+  mkdir -p "${dist_dir}" >/dev/null 2>&1 || return $?
+
+  ${system_python_bin} -m venv ${venv_dir} || return $?
+
+  return 0  
+}
+
+function build() {
+
+  source ${venv_dir}/bin/activate || return $?
+
+  ${venv_python_bin} spec-generator.py || return $?
+
+  return 0
+}
+
+function main() {
+
+  setup || return $?
+
+  build || return $?
+
+  return 0
+}
+
+main
+exit $?