Skip to content

add docstrings

add docstrings #86

name: Deploy to GitHub Pages
# https://jaimestill.github.io/docusaur-gh/config
defaults:
run:
working-directory: docs
on:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/deploy-githubpages.yml'
- 'sunholo/**'
- 'setup.py'
- 'build_scripts/export_docstrings.py'
# Allow manual trigger
workflow_dispatch:
jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: npm
cache-dependency-path: docs/package-lock.json
- name: Install dependencies
run: npm ci
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'
- name: Install pip dependencies
run: pip install --upgrade pip && pip install setuptools && pip install -e .[all] && python build_scripts/export_docstrings.py
working-directory: ${{ github.workspace }}
- name: Build website
run: npm run build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com