Skip to content

Update installation instructions #249

Update installation instructions

Update installation instructions #249

Workflow file for this run

name: Docs
on: [push, pull_request, workflow_dispatch]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: '3.12.0'
- name: Install dependencies
run: |
pip install -r ./doc/requirements.txt
sudo apt-get update -qy
sudo apt-get install -y texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra latexmk
- name: Sphinx build
run: |
cd doc
make clean
make html
- name: Generate offline PDF
run: |
cd doc
make latexpdf
mv build/latex/*.pdf build/html/_static/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/build/html/
force_orphan: true