Skip to content

Docs Build & Deployment #40

Docs Build & Deployment

Docs Build & Deployment #40

Workflow file for this run

name: Docs Build & Deployment
on:
workflow_dispatch:
release:
types: [published]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: '3.10'
cache: 'pip'
cache-dependency-path: setup.py
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install furo
python -m pip install numpydoc
python -m pip install sphinx-gallery
python -m pip install sphinxcontrib-httpdomain
python -m pip install sphinxcontrib-ghcontributors
python -m pip install sphinx-issues
python -m pip install sphinx-copybutton
python -m pip install sphinx
python -m pip install sphinx-design
python -m pip install .
sudo apt-get update -y
sudo apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
- name: Build with Sphinx
run: |
sphinx-build -E -b html ./docsrc/source ./docs
- name: Deploy to GH-Pages
if: always()
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs