Skip to content

adding comments to janus notebook, and reference to class #151

adding comments to janus notebook, and reference to class

adding comments to janus notebook, and reference to class #151

name: Documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: '3.9'
- name: Upgrade pip
run: |
# install pip=>20.1 to use "pip cache dir"
python3 -m pip install --upgrade pip
- name: Install dependencies
run: |
pip install -r requirements/docs.txt
- name: Install netin
run: |
pip install ./
- name: Sphinx build
run: |
sphinx-build docs/source/ docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/main' }}
with:
publish_branch: documentation
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html/