Skip to content

Update README.md

Update README.md #5

Workflow file for this run

name: doc
on:
push:
branches: ["main"]
# Prevent doc action on `main` to conflict with each others.
concurrency:
group: doc-${{ github.ref }}
cancel-in-progress: true
jobs:
doc:
runs-on: "ubuntu-latest"
timeout-minutes: 30
defaults:
run:
shell: bash -l {0}
steps:
- name: Checkout the code
uses: actions/checkout@v4
- name: Setup mamba
uses: mamba-org/setup-micromamba@v1
with:
environment-file: env.yml
environment-name: my_env
cache-environment: true
cache-downloads: true
- name: Install library
run: |
python -m pip install --no-deps .
# Note: Temporarily upgrade mkdocs-jupyter through PyPi
# See https://github.com/conda-forge/mkdocs-jupyter-feedstock/pull/30
python -m pip install mkdocs-jupyter -U --force-reinstall
- name: Configure git
run: |
git config --global user.name "${GITHUB_ACTOR}"
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
- name: Deploy the doc
run: |
echo "Get the gh-pages branch"
git fetch origin gh-pages
echo "Build and deploy the doc on main"
mike deploy --push main