From 54373fb384ee088cc8dd9e06638d922cd1a3b979 Mon Sep 17 00:00:00 2001 From: Bagatur <22008038+baskaryan@users.noreply.github.com> Date: Tue, 13 Feb 2024 16:46:58 -0800 Subject: [PATCH] infra: add api docs build GHA (#17493) --- .github/workflows/api_doc_build.yml | 42 +++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/workflows/api_doc_build.yml diff --git a/.github/workflows/api_doc_build.yml b/.github/workflows/api_doc_build.yml new file mode 100644 index 0000000000000..31ac26469ac2d --- /dev/null +++ b/.github/workflows/api_doc_build.yml @@ -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'