Skip to content

Commit

Permalink
Merge pull request #2854 from ncdc/fix-docs
Browse files Browse the repository at this point in the history
🌱 docs: fix venv
  • Loading branch information
openshift-merge-robot authored Mar 1, 2023
2 parents 424d767 + d5466d1 commit 5d34d08
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/docs-gen-and-push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ jobs:
- uses: actions/setup-python@v4
with:
python-version: '3.10'
# Temporarily turn off caching to see if that fixes CI
#cache: 'pip'
cache: 'pip'

- run: make generate-cli-docs generate-api-docs deploy-docs
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -170,13 +170,16 @@ generate-api-docs:

VENVDIR=$(abspath docs/venv)
REQUIREMENTS_TXT=docs/requirements.txt

.PHONY: serve-docs
serve-docs: venv
. $(VENV)/activate; \
VENV=$(VENV) REMOTE=$(REMOTE) BRANCH=$(BRANCH) hack/serve-docs.sh

.PHONY: deploy-docs
deploy-docs: venv
VENV=$(VENV) REMOTE=$(REMOTE) BRANCH=$(BRANCH) hack/deploy-docs.sh
. $(VENV)/activate; \
REMOTE=$(REMOTE) BRANCH=$(BRANCH) hack/deploy-docs.sh

vendor: ## Vendor the dependencies
go mod tidy
Expand Down
2 changes: 1 addition & 1 deletion hack/deploy-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ if [[ -n "${CI:-}" ]]; then
git config user.email no-reply@kcp.io
fi

"$VENV"/mike deploy "${MIKE_OPTIONS[@]}" "$VERSION"
mike deploy "${MIKE_OPTIONS[@]}" "$VERSION"
2 changes: 1 addition & 1 deletion hack/serve-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ if [[ -n "${BRANCH:-}" ]]; then
MIKE_OPTIONS+=(--branch "$BRANCH")
fi

"$VENV"/mike serve "${MIKE_OPTIONS[@]}"
mike serve "${MIKE_OPTIONS[@]}"

0 comments on commit 5d34d08

Please sign in to comment.