Skip to content

Build Docs

Build Docs #92

Workflow file for this run

name: Build Docs
on:
workflow_dispatch: # manual trigger to kick off workflow
inputs:
logLevel:
description: "Log level"
required: true
default: "warning"
jobs:
build_docs:
runs-on: ubuntu-latest
steps:
- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- name: Checkout iblenv doc build branch
uses: actions/checkout@v3
with:
ref: docs
- name: Checkout ibllib doc build branch
uses: actions/checkout@v3
with:
repository: int-brain-lab/ibllib
ref: docs
path: ibllib-repo
- name: Checkout ONE-api
uses: actions/checkout@v3
with:
repository: int-brain-lab/one
path: ONE
- name: Checkout iblatlas
uses: actions/checkout@v3
with:
repository: int-brain-lab/iblatlas
path: iblatlas
- name: Move ibllib and ONE up a directory
run: |
mv ibllib-repo ..
mv ONE ..
mv iblatlas ..
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Install docs requirements
run: |
sudo apt-get install -y pandoc
export TQDM_DISABLE=1
pip install -r docs_gh_pages/requirements-docs.txt
pip install -e ../ibllib-repo
pip install git+https://github.com/jcouto/wfield.git
pip install jupyter
- name: ONE setup and build docs
run: |
cd docs_gh_pages
python scripts/one_setup.py
python make_script.py -e
ls -l _build
- name: Zip up documentation
run: |
sudo apt-get install -y zip
zip -r build_zip docs_gh_pages/_build
- name: Store zip file as artifacts
uses: actions/upload-artifact@v3
with:
name: build_zip
path: |
build_zip.zip
- name: Copy files to the production website with the AWS CLI
run: |
cd docs_gh_pages/_build/html
aws s3 sync . s3://testdocs.internationalbrainlab.org