Skip to content

perf: use is_coalesced flag in sparse_eye instead of .coalesce() #17

perf: use is_coalesced flag in sparse_eye instead of .coalesce()

perf: use is_coalesced flag in sparse_eye instead of .coalesce() #17

Workflow file for this run

name: Documentation Build Test
# This workflow tests documentation building in CI
# Actual hosting is handled by Read the Docs
on:
push:
branches: [main, tb-dev]
pull_request:
branches: [main]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[docs]
- name: Build documentation
run: |
cd docs
make html
- name: Check documentation
run: |
cd docs
# Check for broken links (optional)
# make linkcheck
echo "Documentation built successfully!"
# ====================================================================
# GITHUB PAGES DEPLOYMENT (currently disabled - using Read the Docs)
# ====================================================================
# To switch from Read the Docs to GitHub Pages hosting:
# 1. Uncomment the deployment step below
# 2. Enable GitHub Pages in repository settings:
# Settings → Pages → Source: GitHub Actions
# 3. Optionally disable Read the Docs builds
# 4. Update any hardcoded URLs in documentation
# - name: Deploy to GitHub Pages
# if: github.ref == 'refs/heads/main' && github.event_name == 'push'
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ./docs/_build/html
# # Optional: Enable if you have a custom domain
# # cname: yourdomain.com
# # Optional: Keep history of deployments
# # keep_files: true
# # Optional: Custom commit message
# # commit_message: 'Deploy documentation ${{ github.sha }}'
# Alternative deployment methods (choose one):
# Option 1: Deploy to gh-pages branch (classic method)
# - name: Deploy to gh-pages branch
# if: github.ref == 'refs/heads/main' && github.event_name == 'push'
# run: |
# cd docs/_build/html
# git init
# git config user.name "GitHub Actions"
# git config user.email "actions@github.com"
# git add .
# git commit -m "Deploy documentation"
# git push --force https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:gh-pages
# Option 2: Deploy to different repository
# - name: Deploy to external repository
# if: github.ref == 'refs/heads/main' && github.event_name == 'push'
# uses: peaceiris/actions-gh-pages@v3
# with:
# personal_token: ${{ secrets.EXTERNAL_REPO_TOKEN }}
# external_repository: yourusername/docs-site
# publish_dir: ./docs/_build/html
# Option 3: Deploy to AWS S3, Azure, etc.
# - name: Deploy to AWS S3
# if: github.ref == 'refs/heads/main' && github.event_name == 'push'
# run: |
# aws s3 sync ./docs/_build/html s3://your-bucket-name --delete
# env:
# AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
# AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
# After switching to GitHub Pages, your docs will be available at:
# https://yourusername.github.io/repositoryname/
# or https://yourdomain.com (if using custom domain)