Skip to content

test doc site generation #30

test doc site generation

test doc site generation #30

Workflow file for this run

name: Build and Deploy Sphinx Documentation
on:
push:
branches:
- master
jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'
- name: Cache Python dependencies
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install squadds library
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -e . -vvv
pip install addict
- name: Install documentation dependencies
run: |
pip install sphinx qiskit-sphinx-theme nbsphinx jupyter_sphinx sphinx_copybutton sphinx_design
- name: Install Pandoc
run: |
sudo apt-get install -y pandoc
- name: Generate documentation
run: |
cd docs
sphinx-apidoc -o source/ ../
- name: Move tutorials to docs/source/tutorials
run: |
cp tutorials/*.ipynb docs/source/tutorials
- name: Build documentation
run: |
cd docs
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.SQuADDS}}
publish_dir: ./docs/build/html