fix(docs): release-3.4 readthedocs backport

Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5 Includes files list from argoproj#12414 description Signed-off-by: jmeridth <[email protected]> Co-authored-by: Anton Gilgur <[email protected]>
jmeridth · Jan 5, 2024 · 157425e · 157425e
1 parent 5dd2c2f
commit 157425e
Show file tree

Hide file tree

Showing 8 changed files with 138 additions and 265 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,11 @@
+version: 2
+formats: all
+mkdocs:
+  fail_on_warning: false
+python:
+  install:
+    - requirements: docs/requirements.txt
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.12"
diff --git a/Makefile b/Makefile
@@ -658,7 +658,7 @@ docs-lint: /usr/local/bin/markdownlint
 	markdownlint docs --fix --ignore docs/fields.md --ignore docs/executor_swagger.md --ignore docs/cli --ignore docs/walk-through/the-structure-of-workflow-specs.md
 
 /usr/local/bin/mkdocs:
-	python -m pip install mkdocs==1.2.4 mkdocs_material==8.1.9  mkdocs-spellcheck==0.2.1
+	python -m pip install --no-cache-dir -r docs/requirements.txt
 
 .PHONY: docs
 docs: /usr/local/bin/mkdocs \
@@ -672,8 +672,6 @@ docs: /usr/local/bin/mkdocs \
 	./hack/check-mkdocs.sh
 	# build the docs
 	mkdocs build
-	# fix the fields.md document
-	go run -tags fields ./hack parseexamples
 	# tell the user the fastest way to edit docs
 	@echo "ℹ️ If you want to preview you docs, open site/index.html. If you want to edit them with hot-reload, run 'make docs-serve' to start mkdocs on port 8000"