Skip to content

update plugin docs

update plugin docs #92

Workflow file for this run

name: Docs
on:
push:
branches:
- develop
paths:
- "docs/**"
pull_request:
branches:
- develop
paths:
- "docs/**"
workflow_dispatch:
jobs:
build-docs:
if: github.repository == 'coronasafe/care'
name: Build docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: "3.11"
cache: 'pipenv'
cache-dependency-path: |
Pipfile.lock
- name: Install pipenv
run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
- name: Install dependencies
run: pipenv sync --categories "docs"
- name: Build docs
run: |
make -C ./docs html
- name: Upload sphinx documentation
uses: actions/upload-artifact@v3
with:
name: sphinx-docs
path: ./docs/_build/html
retention-days: 30
deploy-docs:
if: github.repository == 'coronasafe/care' && github.ref == 'refs/heads/develop'
name: Deploy docs
runs-on: ubuntu-latest
needs: build-docs
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- name: Download sphinx documentation
uses: actions/download-artifact@v3
with:
name: sphinx-docs
path: ./build
- name: Add files to bypass jekyll build
run: |
touch build/.nojekyll
- name: Deploy docs
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: build