Skip to content

updated docs to include Virscan summary example #107

updated docs to include Virscan summary example

updated docs to include Virscan summary example #107

name: docs_pages_workflow
# execute this workflow automatically when a we push to master
on:
push:
branches: [ main ]
jobs:
build_docs_job:
runs-on: ubuntu-latest
# container: debian:buster-slim
container: debian:buster
strategy:
matrix:
python-version: [3.7]
steps:
# - uses: actions/checkout@v3
# - name: Set up Python ${{ matrix.python-version }}
# uses: actions/setup-python@v4
# with:
# python-version: ${{ matrix.python-version }}
# - name: Install dependencies
# run: |
# python -m pip install --upgrade pip
# - name: Install phippery
# run: |
# pip install -e ".[dev]"
- name: Prereqs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
apt-get update
apt-get install -y git python3-pip
git clone --depth 1 "https://token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" .
git config --global --add safe.directory /__w/phippery/phippery
shell: bash
# TODO, do we really need to install phippery?
# could we just install all the other pre-reqs
- name: Install phippery
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -e ".[dev]"
shell: bash
- name: Execute script to build our documentation and update pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: "docs/buildDocs.sh"
shell: bash