Skip to content

Commit

Permalink
Add gh-pages deploy bot (#225)
Browse files Browse the repository at this point in the history
* Add gh-pages deploy bot

* Add dependencies for gh-pages bot

* Add missing jupyterlab dependency

* Use pandoc Actions

* Minor fixes

* Test macOS environment
  • Loading branch information
zhiqwang authored Nov 2, 2021
1 parent f2d1363 commit 284e3e2
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 1 deletion.
65 changes: 65 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Build & deploy documentation

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
deploy:
runs-on: macos-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}

steps:
- uses: actions/checkout@v2

- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.8'

- name: Install brew dependencies
run: |
brew update
brew install pandoc
- name: Upgrade pip
run: |
# install pip=>20.1 to use "pip cache dir"
python3 -m pip install --upgrade pip
- name: Install pip dependencies
run: |
# requirements for unittest
pip install numpy
pip install torch torchvision
pip install opencv-python pycocotools>=2.0.2 onnxruntime
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Get pip cache dir
id: pip-cache
run: echo "::set-output name=dir::$(pip cache dir)"

- name: Cache dependencies
uses: actions/cache@v2
with:
path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Build docs
run: |
cd docs
pip install --progress-bar off -r requirements.txt
make help
make html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html
if: github.event_name != 'pull_request'
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
numpy
jupyterlab
sphinx==3.5.4
insipid-sphinx-theme
nbsphinx
nbsphinx==0.8.7

0 comments on commit 284e3e2

Please sign in to comment.