From ffb7ff5e7f6911e76ab487ef07b866fe2e15fcc6 Mon Sep 17 00:00:00 2001 From: adamdebek Date: Mon, 15 Jul 2024 15:20:23 +0200 Subject: [PATCH] add ci-doc workflow JIRA: CI-462 --- .github/workflows/ci-doc.yml | 68 ++++++++++++++++++++++++++++++++++++ requirements.txt | 5 +++ 2 files changed, 73 insertions(+) create mode 100644 .github/workflows/ci-doc.yml create mode 100644 requirements.txt diff --git a/.github/workflows/ci-doc.yml b/.github/workflows/ci-doc.yml new file mode 100644 index 00000000..9c87c21c --- /dev/null +++ b/.github/workflows/ci-doc.yml @@ -0,0 +1,68 @@ +# vim:sw=2:ts=2 +# build html version of docs, deploy on merge to docs.phoenix-rtos.com +name: ci-doc + +# on events +on: + push: + branches: + - master + - 'feature/*' + pull_request: + branches: + - master + - 'feature/*' + +jobs: + build-docs: + runs-on: ubuntu-latest + name: build + + steps: + - uses: actions/checkout@v4 + - uses: sphinx-doc/github-problem-matcher@master + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: "3.10" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + + - name: Build docs + run: | + make clean html SPHINXOPTS="-W --keep-going -n" + continue-on-error: false + + - name: Upload build artifact + if: github.event_name == 'push' + uses: actions/upload-artifact@v4 + with: + name: html_build + path: _build + if-no-files-found: error + + deploy-docs: + runs-on: ubuntu-latest + name: deploy + needs: build + if: github.event_name == 'push' + + steps: + run: | + echo "essa" + + # steps: + # - name: Download build artifact + # uses: actions/download-artifact@v4 + # with: + # name: html_build + # path: _build + # if-no-files-found: error + + # - name: Deploy docs + # run: | + # send cmd diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..80cbbfc7 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +sphinx==7.2.6 +sphinx_copybutton==0.5.2 +myst-parser==2.0.0 +furo==2024.1.29 +pygments==2.17.2