generated from hadenlabs/base-template
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): implement docs task (#2)
- Loading branch information
Showing
1 changed file
with
63 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
version: "3" | ||
|
||
tasks: | ||
check: | ||
desc: Exist mkdocs and grip dependences | ||
run: once | ||
deps: | ||
- task: check:python | ||
- task: check:poetry | ||
- task: check:mkdocs | ||
- task: check:grip | ||
|
||
check:python: | ||
desc: Exist Python | ||
run: once | ||
preconditions: | ||
- sh: command -v python | ||
msg: "Please Install python" | ||
|
||
check:poetry: | ||
desc: Exist Poetry | ||
run: once | ||
preconditions: | ||
- sh: command -v poetry | ||
msg: "Please Install poetry" | ||
|
||
check:mkdocs: | ||
desc: Exist mkdocs | ||
run: once | ||
preconditions: | ||
- sh: test "poetry run command -v mkdocs" | ||
msg: "Please Install mkdocs" | ||
|
||
check:grip: | ||
desc: Exist grip | ||
run: once | ||
preconditions: | ||
- sh: test "poetry run command -v grip" | ||
msg: "Please Install grip" | ||
|
||
show: | ||
desc: Show grip readme. | ||
run: once | ||
cmds: | ||
- poetry run grip | ||
deps: | ||
- task: check:grip | ||
|
||
build: | ||
desc: Build documentation with mkdocs. | ||
run: once | ||
cmds: | ||
- poetry run mkdocs build | ||
deps: | ||
- task: check:mkdocs | ||
|
||
serve: | ||
desc: Server make documentation. | ||
run: once | ||
cmds: | ||
- poetry run mkdocs serve --dev-addr '127.0.0.1:8001' | ||
deps: | ||
- task: check:mkdocs |