Skip to content

Commit

Permalink
Add an environment to build temporalio docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tristanlatr committed Nov 21, 2024
1 parent b504c21 commit 25b5e62
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/system.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:

strategy:
matrix:
tox_target: [twisted-apidoc, cpython-summary, python-igraph-apidocs, cpython-apidocs, numpy-apidocs, git-buildpackage-apidocs, pytype-apidocs]
tox_target: [twisted-apidoc, cpython-summary, python-igraph-apidocs, cpython-apidocs, numpy-apidocs, git-buildpackage-apidocs, pytype-apidocs, temporalio-apidocs]

steps:
- uses: actions/checkout@v4
Expand Down
12 changes: 12 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,18 @@ commands =
# Code 2 error means bad docstrings, which is OK for this test.
assert code==2, 'pydoctor exited with code %s, expected code 2.'%code"

[testenv:temporalio-apidocs]
description = Build temporalio/sdk-python API documentation.
commands =
sh -c "if [ ! -d {toxworkdir}/temporalio ]; then \
git clone --depth 1 https://github.com/temporalio/sdk-python.git {toxworkdir}/temporalio; \
fi"
sh -c "cd {toxworkdir}/temporalio && git pull"
rm -rf {toxworkdir}/temporalio-output
sh -c "pydoctor --config={toxworkdir}/temporalio/pyproject.toml \
--html-output={toxworkdir}/temporalio-output --theme=readthedocs \
--quiet --add-package={toxworkdir}/temporalio/temporalio"

# Requires cmake
[testenv:python-igraph-apidocs]
description = Build python-igraph API documentation
Expand Down

0 comments on commit 25b5e62

Please sign in to comment.