Skip to content

Commit

Permalink
add ci-doc workflow
Browse files Browse the repository at this point in the history
JIRA: CI-462
  • Loading branch information
adamdebek committed Jul 16, 2024
1 parent 46b7ea9 commit 73edf76
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/workflows/ci-doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# 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:
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
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:
runs-on: ubuntu-latest
name: deploy
needs: build
if: github.event_name == 'push'

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
5 changes: 5 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 73edf76

Please sign in to comment.