Skip to content

Update README.md

Update README.md #334

Workflow file for this run

name: Docs
on: [push, pull_request, workflow_dispatch]
jobs:
docs:
if: ${{ github.event.head_commit.message != 'Github Actions- Update README'}}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install . -U
python -m pip install flake8 pytest
pip install -r requirements.txt
pip install sphinx sphinx_rtd_theme
- name: Sphinx build
run: |
sphinx-build docs _build
- 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: _build/
force_orphan: true