Skip to content

Add TOC to README

Add TOC to README #81

Workflow file for this run

name: docs-build
on:
pull_request:
branches:
- main
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install dependencies
run: |
pip install --no-cache-dir Cython
pip install -r requirements.txt -r requirements_dev.txt
pip install .
# - name: Discover typos with codespell
# run: codespell --skip="*.csv,*.geojson,*.json,*.js,*.html,*cff,*.pdf,./.git" --ignore-words-list="aci,acount,hist"
- name: PKG-TEST
run: |
python -m unittest discover tests/
- name: Convert Jupyter notebook to markdown
run: |
jupyter nbconvert nbs/quickstart.ipynb --to markdown --output-dir docs/examples/
- name: Build docs
run: |
mkdocs build
# - name: Deploy to Netlify
# uses: nwtgck/[email protected]
# with:
# publish-dir: "./site"
# production-branch: main
# github-token: ${{ secrets.GITHUB_TOKEN }}
# deploy-message: "Deploy from GitHub Actions"
# enable-pull-request-comment: true
# enable-commit-comment: false
# overwrites-pull-request-comment: true
# env:
# NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
# NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
# timeout-minutes: 10