From d5f10276ee32a7c9ba30e14990027a63bdfde9f5 Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Thu, 20 Mar 2025 12:52:55 +0100 Subject: [PATCH] Moved sphinx files --- .gitignore | 1 - docs/.gitignore | 2 ++ {sphinx => docs}/Makefile | 2 +- {sphinx => docs}/README.md | 0 {sphinx => docs}/assets/js/current-nav.js | 0 {sphinx => docs}/conf.py | 0 {sphinx => docs}/extensions/__init__.py | 0 {sphinx => docs}/extensions/local_file_headings.py | 0 {sphinx => docs}/extensions/local_subfolders.py | 0 {sphinx => docs}/extensions/markdown_include.py | 0 {sphinx => docs}/extensions/nav_utils.py | 0 {sphinx => docs}/extensions/roles_overview.py | 0 {sphinx => docs}/requirements.txt | 0 {sphinx => docs}/templates/logo.html | 0 {sphinx => docs}/templates/structure.html | 0 group_vars/all/07_applications.yml | 14 +++++++------- sphinx/.gitignore | 1 - 17 files changed, 10 insertions(+), 10 deletions(-) create mode 100644 docs/.gitignore rename {sphinx => docs}/Makefile (97%) rename {sphinx => docs}/README.md (100%) rename {sphinx => docs}/assets/js/current-nav.js (100%) rename {sphinx => docs}/conf.py (100%) rename {sphinx => docs}/extensions/__init__.py (100%) rename {sphinx => docs}/extensions/local_file_headings.py (100%) rename {sphinx => docs}/extensions/local_subfolders.py (100%) rename {sphinx => docs}/extensions/markdown_include.py (100%) rename {sphinx => docs}/extensions/nav_utils.py (100%) rename {sphinx => docs}/extensions/roles_overview.py (100%) rename {sphinx => docs}/requirements.txt (100%) rename {sphinx => docs}/templates/logo.html (100%) rename {sphinx => docs}/templates/structure.html (100%) delete mode 100644 sphinx/.gitignore diff --git a/.gitignore b/.gitignore index 0e460dd5..2862954e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ site.retry *__pycache__ -docs/* venv *.log modules/* \ No newline at end of file diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..ce2f9493 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +assets/img/* +generated/* \ No newline at end of file diff --git a/sphinx/Makefile b/docs/Makefile similarity index 97% rename from sphinx/Makefile rename to docs/Makefile index f14f1220..960bd7e8 100644 --- a/sphinx/Makefile +++ b/docs/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS ?= -c . SPHINXBUILD ?= sphinx-build SPHINX_SOURCE_DIR ?= ../ -SPHINX_BUILD_DIR ?= ../docs +SPHINX_BUILD_DIR ?= ./generated SPHINX_APIDOC_BUILD_DIR = $(SPHINX_SOURCE_DIR)modules .PHONY: help install copy-images apidoc remove-apidoc html Makefile diff --git a/sphinx/README.md b/docs/README.md similarity index 100% rename from sphinx/README.md rename to docs/README.md diff --git a/sphinx/assets/js/current-nav.js b/docs/assets/js/current-nav.js similarity index 100% rename from sphinx/assets/js/current-nav.js rename to docs/assets/js/current-nav.js diff --git a/sphinx/conf.py b/docs/conf.py similarity index 100% rename from sphinx/conf.py rename to docs/conf.py diff --git a/sphinx/extensions/__init__.py b/docs/extensions/__init__.py similarity index 100% rename from sphinx/extensions/__init__.py rename to docs/extensions/__init__.py diff --git a/sphinx/extensions/local_file_headings.py b/docs/extensions/local_file_headings.py similarity index 100% rename from sphinx/extensions/local_file_headings.py rename to docs/extensions/local_file_headings.py diff --git a/sphinx/extensions/local_subfolders.py b/docs/extensions/local_subfolders.py similarity index 100% rename from sphinx/extensions/local_subfolders.py rename to docs/extensions/local_subfolders.py diff --git a/sphinx/extensions/markdown_include.py b/docs/extensions/markdown_include.py similarity index 100% rename from sphinx/extensions/markdown_include.py rename to docs/extensions/markdown_include.py diff --git a/sphinx/extensions/nav_utils.py b/docs/extensions/nav_utils.py similarity index 100% rename from sphinx/extensions/nav_utils.py rename to docs/extensions/nav_utils.py diff --git a/sphinx/extensions/roles_overview.py b/docs/extensions/roles_overview.py similarity index 100% rename from sphinx/extensions/roles_overview.py rename to docs/extensions/roles_overview.py diff --git a/sphinx/requirements.txt b/docs/requirements.txt similarity index 100% rename from sphinx/requirements.txt rename to docs/requirements.txt diff --git a/sphinx/templates/logo.html b/docs/templates/logo.html similarity index 100% rename from sphinx/templates/logo.html rename to docs/templates/logo.html diff --git a/sphinx/templates/structure.html b/docs/templates/structure.html similarity index 100% rename from sphinx/templates/structure.html rename to docs/templates/structure.html diff --git a/group_vars/all/07_applications.yml b/group_vars/all/07_applications.yml index f77b76a1..587de490 100644 --- a/group_vars/all/07_applications.yml +++ b/group_vars/all/07_applications.yml @@ -632,7 +632,7 @@ defaults_applications: portfolio: database: - central_storage: False # Portfolio doesn't use any database + central_storage: False # Portfolio doesn't use any database matomo_tracking_enabled: "{{matomo_tracking_enabled_default}}" # Enables\Disables Matomo Tracking css_enabled: "{{css_enabled_default}}" # Enables\Disables Global CSS Style landingpage_iframe_enabled: false # Doesn't make sense to load landingpage in landingpage @@ -648,12 +648,12 @@ defaults_applications: ## Sphinx sphinx: - version: "3.9-slim" # Use latest docker image - repository_sphinx_source: "https://github.com/kevinveenbirkenbach/cymais.git" # Repository address to pull the source repository from - sphinx_exec_dir_relative: "sphinx/" # The relative path to the sphinx Makefile folder from the source dir - matomo_tracking_enabled: "{{matomo_tracking_enabled_default}}" # Enables\Disables Matomo Tracking - css_enabled: "{{css_enabled_default}}" # Enables\Disables Global CSS Style - landingpage_iframe_enabled: true # Makes sense to make the documentary allways in iframe available + version: "3.9-slim" # Use latest docker image + repository_sphinx_source: "https://github.com/kevinveenbirkenbach/cymais.git" # Repository address to pull the source repository from + sphinx_exec_dir_relative: "docs/" # The relative path to the sphinx Makefile folder from the source dir + matomo_tracking_enabled: "{{matomo_tracking_enabled_default}}" # Enables\Disables Matomo Tracking + css_enabled: "{{css_enabled_default}}" # Enables\Disables Global CSS Style + landingpage_iframe_enabled: true # Makes sense to make the documentary allways in iframe available ## Taiga diff --git a/sphinx/.gitignore b/sphinx/.gitignore deleted file mode 100644 index e8524b9d..00000000 --- a/sphinx/.gitignore +++ /dev/null @@ -1 +0,0 @@ -assets/img/* \ No newline at end of file