Skip to content

add readme

add readme #29

Workflow file for this run

name: gendocs
on: [push, workflow_dispatch]
jobs:
gendocs:
runs-on: ubuntu-latest
permissions:
contents: read
deployments: write
name: Deploy to Cloudflare Pages
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '11'
- name: Set up Python 3.11
uses: actions/setup-python@v3
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .
pip install sphinx furo sphinx-autoapi sphinx_autodoc_typehints
- name: Sphinx build
run: |
sphinx-build -M html docs/source docs/build
- name: Publish
uses: cloudflare/pages-action@1
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: aa2caed8dec0b29b442a9f250bd48ba6
projectName: docs
directory: docs/build/html
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
wranglerVersion: '3'