Skip to content

Commit

Permalink
chore: Configure go-task
Browse files Browse the repository at this point in the history
  • Loading branch information
attakei committed Feb 17, 2025
1 parent 18edadd commit a6730ab
Show file tree
Hide file tree
Showing 5 changed files with 145 additions and 0 deletions.
1 change: 1 addition & 0 deletions .mise.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[tools]
lefthook = "latest"
task = "latest"
uv = "latest"
37 changes: 37 additions & 0 deletions Taskfile.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
version: '3'

vars:
# If you run bare environment or activated venv, set '' (blank string)
RUN_PYTHON: 'uv run'

tasks:
setup:
desc: 'Setup workspace'
cmds:
- 'uv sync --frozen --all-extras'
- 'lefthook install'
- task: 'docs:apidoc'
verify:
desc: 'Verify environment by all procs'
cmds:
- 'lefthook run pre-commit --all-files'
- '{{.RUN_PYTHON}} pytest'
- task: 'docs:intl'
- task: 'docs:apidoc'
- task: 'docs:build-linkcheck'
- task: 'docs:build-dirhtml'
- task: 'demo:intl'
- task: 'docs:build-linkcheck'
- task: 'demo:build'
- 'uv build'
release-*:
desc: 'Run release process'
vars:
VERSION: '{{index .MATCH 0}}'
cmds:
- 'age update {{.VERSION}}'
- 'uv sync --all-extras' # To write out as lock-file

includes:
docs: './doc'
demo: './demo'
46 changes: 46 additions & 0 deletions demo/Taskfile.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
version: '3'

vars:
# If you run bare environment or activated venv, set '' (blank string)
# RUN_PYTHON: ''
SPHINX_DEFAULT_BUILD: 'mini18n-dirrevealjs'
SPHINX_SOURCE_DIR: '.'
SPHINX_OUTPUT_DIR: '_build'
SPHINX_OPTIONS: ''
SPHINX_LANGUAGES:
- 'ja'

env:
SPHINXINTL_TRANSLATOR: "Kazuya Takei <[email protected]>"

tasks:
intl:
desc: 'Sync i18n environment'
dir: '{{.TASKFILE_DIR}}'
cmds:
- '{{.RUN_PYTHON}} sphinx-build -M gettext {{.SPHINX_SOURCE_DIR}} {{.SPHINX_OUTPUT_DIR}} {{.SPHINX_OPTIONS}}'
- '{{.RUN_PYTHON}} sphinx-intl update --language={{.SPHINX_LANGUAGES | join ","}}'
dev:
desc: 'Run docs server'
dir: '{{.TASKFILE_DIR}}'
cmds:
- '{{.RUN_PYTHON}} sphinx-autobuild -b dirrevealjs {{.SPHINX_SOURCE_DIR}} {{.SPHINX_OUTPUT_DIR}}/dirrevealjs'
build-*:
desc: 'Make docs'
dir: '{{.TASKFILE_DIR}}'
vars:
TARGET: '{{index .MATCH 0}}'
cmds:
- '{{.RUN_PYTHON}} sphinx-build -M {{.TARGET}} {{.SPHINX_SOURCE_DIR}} {{.SPHINX_OUTPUT_DIR}}'
build:
desc: 'Make docs (default target)'
deps:
- 'build-{{.SPHINX_DEFAULT_BUILD}}'
help:
desc: 'Display help of docs'
deps:
- 'build-help'
clean:
desc: 'Clean build files of docs'
deps:
- 'build-clean'
52 changes: 52 additions & 0 deletions doc/Taskfile.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
version: '3'

vars:
# If you run bare environment or activated venv, set '' (blank string)
# RUN_PYTHON: ''
SPHINX_DEFAULT_BUILD: 'dirhtml'
SPHINX_SOURCE_DIR: '.'
SPHINX_OUTPUT_DIR: '_build'
SPHINX_OPTIONS: ''
SPHINX_LANGUAGES:
- 'ja'

env:
SPHINXINTL_TRANSLATOR: "Kazuya Takei <[email protected]>"

tasks:
intl:
desc: 'Sync i18n environment'
dir: '{{.TASKFILE_DIR}}'
cmds:
- '{{.RUN_PYTHON}} sphinx-build -M gettext {{.SPHINX_SOURCE_DIR}} {{.SPHINX_OUTPUT_DIR}} {{.SPHINX_OPTIONS}}'
- '{{.RUN_PYTHON}} sphinx-intl update --language={{.SPHINX_LANGUAGES | join ","}}'
dev:
desc: 'Run docs server'
dir: '{{.TASKFILE_DIR}}'
cmds:
- '{{.RUN_PYTHON}} sphinx-autobuild -b dirhtml {{.SPHINX_SOURCE_DIR}} {{.SPHINX_OUTPUT_DIR}}/dirhtml'
apidoc:
desc: 'Update apidoc'
dir: '{{.TASKFILE_DIR}}'
cmds:
- 'rm -rf api'
- '{{.RUN_PYTHON}} sphinx-apidoc -f -e -T -o=api/ ../sphinx_revealjs'
build-*:
desc: 'Make docs'
dir: '{{.TASKFILE_DIR}}'
vars:
TARGET: '{{index .MATCH 0}}'
cmds:
- '{{.RUN_PYTHON}} sphinx-build -M {{.TARGET}} {{.SPHINX_SOURCE_DIR}} {{.SPHINX_OUTPUT_DIR}}'
build:
desc: 'Make docs (default target)'
deps:
- 'build-{{.SPHINX_DEFAULT_BUILD}}'
help:
desc: 'Display help of docs'
deps:
- 'build-help'
clean:
desc: 'Clean build files of docs'
deps:
- 'build-clean'
9 changes: 9 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,15 @@
epub_title = project
epub_exclude_files = ["search.html"]

# -- Options for Linkcheck output
linkcheck_ignore = [
r"./docs/migrations", # TODO: Fix after.
# TODO: Migrate ``linkcheck_anchors_ignore_for_url``
r"https://attakei.github.io/sphinx-revealjs/en/#/5/1",
r"https://revealjs.com/#/",
r"https://revealjs.com/code/#line-numbers-%26-highlights",
]

# -- Extension configuration -------------------------------------------------
# For sphinx.ext.intersphinx
intersphinx_mapping = {
Expand Down

0 comments on commit a6730ab

Please sign in to comment.