Skip to content

fix(docs): Update docs building tasks to use new yscope-dev-utils tasks. #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sitaowang1998 merged 2 commits into from
May 5, 2025
Merged

fix(docs): Update docs building tasks to use new yscope-dev-utils tasks. #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a91cdd
Fix task from yscope-dev-utils
sitaowang1998 May 5, 2025
5e58a2c
Remove glob reference and aphabetize the argument lists
sitaowang1998 May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions docs/tasks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ tasks:
dir: "{{.TASKFILE_DIR}}"
deps:
- ":init"
- task: ":utils:validate-checksum"
- task: ":utils:checksum:validate"
vars:
CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
DATA_DIR: "{{.OUTPUT_DIR}}"
INCLUDE_PATTERNS: ["{{.OUTPUT_DIR}}"]
- "docs-venv"
cmds:
# Call `clean` before building since `sphinx-build --write-all --fresh-env` isn't always
Expand All @@ -50,10 +50,10 @@ tasks:
--builder html \
src "{{.OUTPUT_DIR}}"
# This command must be last
- task: ":utils:compute-checksum"
- task: ":utils:checksum:compute"
vars:
DATA_DIR: "{{.OUTPUT_DIR}}"
OUTPUT_FILE: "{{.CHECKSUM_FILE}}"
CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
INCLUDE_PATTERNS: ["{{.OUTPUT_DIR}}"]
sources:
- "{{.G_DOCS_VENV_CHECKSUM_FILE}}"
- "{{.ROOT_DIR}}/taskfile.yaml"
Expand All @@ -70,21 +70,21 @@ tasks:
REQUIREMENTS_FILE: "docs/requirements.txt"
deps:
- ":init"
- task: ":utils:validate-checksum"
- task: ":utils:checksum:validate"
vars:
CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
DATA_DIR: "{{.OUTPUT_DIR}}"
INCLUDE_PATTERNS: ["{{.OUTPUT_DIR}}"]
cmds:
- task: ":utils:create-venv"
- task: ":utils:misc:create-venv"
vars:
LABEL: "docs"
OUTPUT_DIR: "{{.OUTPUT_DIR}}"
REQUIREMENTS_FILE: "{{.REQUIREMENTS_FILE}}"
# This command must be last
- task: ":utils:compute-checksum"
- task: ":utils:checksum:compute"
vars:
DATA_DIR: "{{.OUTPUT_DIR}}"
OUTPUT_FILE: "{{.CHECKSUM_FILE}}"
CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
INCLUDE_PATTERNS: ["{{.OUTPUT_DIR}}"]
sources:
- "{{.REQUIREMENTS_FILE}}"
- "{{.ROOT_DIR}}/taskfile.yaml"
Expand All @@ -98,18 +98,18 @@ tasks:
OUTPUT_DIR: "{{.G_NODE_DEPS_DIR}}"
deps:
- ":init"
- task: ":utils:validate-checksum"
- task: ":utils:checksum:validate"
vars:
CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
DATA_DIR: "{{.OUTPUT_DIR}}"
INCLUDE_PATTERNS: ["{{.OUTPUT_DIR}}"]
cmds:
- "rm -rf '{{.OUTPUT_DIR}}'"
- "npm --prefix '{{.OUTPUT_DIR}}' install http-server"
# This command must be last
- task: ":utils:compute-checksum"
- task: ":utils:checksum:compute"
vars:
DATA_DIR: "{{.OUTPUT_DIR}}"
OUTPUT_FILE: "{{.CHECKSUM_FILE}}"
CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
INCLUDE_PATTERNS: ["{{.OUTPUT_DIR}}"]
sources:
- "{{.ROOT_DIR}}/taskfile.yaml"
- "{{.TASKFILE}}"
Expand Down