diff --git a/.vscode/settings.json b/.vscode/settings.json index 7b90770..a88333f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -65,6 +65,6 @@ "patternlinks.rules": [ - ], + ] } diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 3e874e6..07b4179 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -34,14 +34,29 @@ } }, { - "label": "html-live", + "label": "config", "type": "shell", - "command": "make -f docs/Makefile html-live", + "command": "make -f docs/Makefile config", "options": { "statusbar": { "hide": false } }, + "problemMatcher": [], + "group": { + "kind": "build", + "isDefault": false + } + }, + { + "label": "html", + "type": "shell", + "command": "make -f docs/Makefile html", + "options": { + "statusbar": { + "hide": true + } + }, "problemMatcher": [ { "owner": "sphinx", @@ -57,16 +72,16 @@ ], "group": { "kind": "build", - "isDefault": true + "isDefault": false } }, { - "label": "html", + "label": "html-live", "type": "shell", - "command": "make -f docs/Makefile html", + "command": "make -f docs/Makefile html-live", "options": { "statusbar": { - "hide": true + "hide": false } }, "problemMatcher": [ @@ -84,7 +99,7 @@ ], "group": { "kind": "build", - "isDefault": false + "isDefault": true } } ] diff --git a/docs/Kconfig b/docs/Kconfig index 6874752..f436d71 100644 --- a/docs/Kconfig +++ b/docs/Kconfig @@ -2,19 +2,19 @@ menu "doc" config DOC__TITLE string "Title" - default "Alexander Mann-Wahrenberg's Homepage" + default "The Default Title" config DOC__AUTHOR string "Author" - default "Basejumpa" + default "The Default Author" config DOC__YEAR int "Year" - default 2024 + default 1976 config DOC__PROJECT string "Project" - default "Homepage" + default "The Default Project" config DOC__LANGUAGE string "Language" diff --git a/docs/Makefile b/docs/Makefile index b1d93b0..4bb3a93 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -113,24 +113,40 @@ deps-are-up-to-date: poetry.toml pyproject.toml poetry update -.PHONY: deps-are-up-to-date-live -deps-are-up-to-date-live: poetry.toml pyproject.toml +.PHONY: deps-are-up-to-date-dev +deps-are-up-to-date-dev: poetry.toml pyproject.toml poetry update --with dev +.PHONY: clean +clean: + rm -rf "$(CONFIG_BUILD__DIRS__BUILD)" + + clean-install: rm -rf .venv/ rm -rf .tools/ rm -f poetry.lock -.PHONY: clean -clean: - rm -rf "$(CONFIG_BUILD__DIRS__BUILD)" +.PHONY: config +config: .tools/.are-up-to-date deps-are-up-to-date-dev + (cd "$(CONFIG_BUILD__DIRS__CONFIG)" ; poetry run menuconfig ) + + +.PHONY: html +html: .tools/.are-up-to-date deps-are-up-to-date + mkdir -p "$(CONFIG_BUILD__DIRS__BUILD)/$@" + @echo "Building sources at $(CONFIG_BUILD__DIRS__SOURCE)" + poetry run sphinx-build \ + -W \ + -c "$(CONFIG_BUILD__DIRS__CONFIG)" \ + "$(CONFIG_BUILD__DIRS__SOURCE)" \ + "$(CONFIG_BUILD__DIRS__BUILD)/$@" .PHONY: html-live -html-live: .tools/.are-up-to-date deps-are-up-to-date-live +html-live: .tools/.are-up-to-date deps-are-up-to-date-dev mkdir -p "$(CONFIG_BUILD__DIRS__BUILD)/$@" # Start continuous build, open browser automatically which reloads on change. @echo "Building sources at $(CONFIG_BUILD__DIRS__SOURCE)" @@ -145,13 +161,3 @@ html-live: .tools/.are-up-to-date deps-are-up-to-date-live --port "$(CONFIG_BUILD__LIVE__PORTS__HTML)" \ --open-browser - -.PHONY: html -html: .tools/.are-up-to-date deps-are-up-to-date - mkdir -p "$(CONFIG_BUILD__DIRS__BUILD)/$@" - @echo "Building sources at $(CONFIG_BUILD__DIRS__SOURCE)" - poetry run sphinx-build \ - -W \ - -c "$(CONFIG_BUILD__DIRS__CONFIG)" \ - "$(CONFIG_BUILD__DIRS__SOURCE)" \ - "$(CONFIG_BUILD__DIRS__BUILD)/$@" diff --git a/pyproject.toml b/pyproject.toml index 3f9fb3e..b7b1077 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,21 +3,22 @@ package-mode = false [tool.poetry.dependencies] python = "^3.10" -sphinx = "^7.4.7" setuptools = "^71.1.0" -sphinxcontrib-bibtex = "^2.6.2" +sphinx = "^7.4.7" sphinx-copybutton = "^0.5.2" -pydata-sphinx-theme = "^0.15.4" sphinx-design = "^0.6.0" +sphinxcontrib-bibtex = "^2.6.2" sphinxcontrib-drawio = "^0.0.17" sphinxcontrib-plantuml = "^0.30" sphinxcontrib-mermaid = "^0.9.2" -ablog = "^0.11.10" sphinxcontrib-youtube = "^1.4.1" +pydata-sphinx-theme = "^0.15.4" +ablog = "^0.11.10" [tool.poetry.group.dev.dependencies] sphinx-autobuild = "^2024.4.16" +kconfiglib = "^14.1.0" [build-system] requires = ["poetry-core"]