Skip to content

Commit a8074f1

Browse files
authored
Merge pull request #2023 from M00nF1sh/main_doc_tune
fix docs theme with latest mkdocs-material & pin docs dev environment
2 parents 07a29df + 35ec0b8 commit a8074f1

File tree

5 files changed

+458
-43
lines changed

5 files changed

+458
-43
lines changed

Makefile

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,17 @@ else
7979
CONTROLLER_GEN=$(shell which controller-gen)
8080
endif
8181

82+
# preview docs
83+
docs-preview: docs-dependencies
84+
pipenv run mkdocs serve
85+
8286
# publish the versioned docs using mkdocs mike util
83-
docs-publish:
84-
mike deploy v2.0 latest -p
87+
docs-publish: docs-dependencies
88+
pipenv run mike deploy v2.2 latest -p --update-aliases
89+
90+
# install dependencies needed to preview and publish docs
91+
docs-dependencies:
92+
pipenv install --dev
8593

8694
lint:
8795
echo "TODO"

Pipfile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[[source]]
2+
url = "https://pypi.org/simple"
3+
verify_ssl = true
4+
name = "pypi"
5+
6+
[packages]
7+
8+
[dev-packages]
9+
mkdocs = "==1.1.2"
10+
mkdocs-material = "==7.1.5"
11+
mike = "==1.0.0"
12+
13+
[requires]
14+
python_version = "3.9"

0 commit comments

Comments
 (0)