Skip to content

doc: add initial structure for documentation #1

doc: add initial structure for documentation

doc: add initial structure for documentation #1

Workflow file for this run

name: "Sphinx: Render docs"
on: push
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout source code
uses: actions/checkout@v3
- name: Install poetry
run: pipx install poetry
- name: Set up Python 3.12
uses: actions/setup-python@v4
with:
python-version: "3.12"
cache: "poetry"
- name: Install dependencies
run: poetry install --no-interaction --with doc
- name: Build doc
run: make -C docs html
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/_build/html/
- name: Deploy to GitHub pages
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main' || github.ref == 'ref/heads/add-sphinx-doc'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html