Skip to content

update formats to add shape-mapper docs #34

update formats to add shape-mapper docs

update formats to add shape-mapper docs #34

Workflow file for this run

name: "Docs"
on: [push, pull_request, workflow_dispatch]
permissions:
actions: write
checks: write
contents: write
deployments: write
id-token: write
issues: write
discussions: write
packages: write
pages: write
pull-requests: write
repository-projects: write
security-events: write
statuses: write
env:
CACHE_NUMBER: 1 # increase to reset cache manually
jobs:
Build-Docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Install requirements
run: |
pip install sphinx sphinx_rtd_theme
pip install -r requirements.txt
pip install .
- name: Sphinx build
run: |
sphinx-build docs/source _build -d dirbuild
- 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