-
Notifications
You must be signed in to change notification settings - Fork 15.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
infra: add api docs build GHA (#17493)
- Loading branch information
Showing
1 changed file
with
42 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,42 @@ | ||
name: API docs build | ||
|
||
on: | ||
workflow_dispatch: | ||
schedule: | ||
- cron: '0 13 * * *' | ||
env: | ||
POETRY_VERSION: "1.7.1" | ||
PYTHON_VERSION: "3.10" | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
ref: bagatur/api_docs_build | ||
|
||
- name: Set up Python ${{ env.PYTHON_VERSION }} + Poetry ${{ env.POETRY_VERSION }} | ||
uses: "./.github/actions/poetry_setup" | ||
with: | ||
python-version: ${{ env.PYTHON_VERSION }} | ||
poetry-version: ${{ env.POETRY_VERSION }} | ||
cache-key: api-docs | ||
|
||
- name: Install dependencies | ||
run: | | ||
poetry run python -m pip install --upgrade --no-cache-dir pip setuptools | ||
poetry run python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext | ||
poetry run python -m pip install ./libs/partners/* | ||
poetry run python -m pip install --exists-action=w --no-cache-dir -r docs/api_reference/requirements.txt | ||
- name: Build docs | ||
run: | | ||
poetry run python -m pip install --upgrade --no-cache-dir pip setuptools | ||
poetry run python docs/api_reference/create_api_rst.py | ||
poetry run python -m sphinx -T -E -b html -d _build/doctrees -c docs/api_reference docs/api_reference api_reference_build/html -j auto | ||
# https://github.com/marketplace/actions/add-commit | ||
- uses: EndBug/add-and-commit@v9 | ||
with: | ||
message: 'Update API docs build' |