Skip to content

Add polished docs site: hero landing page, red palette, SEO #6

Add polished docs site: hero landing page, red palette, SEO

Add polished docs site: hero landing page, red palette, SEO #6

Workflow file for this run

name: Deploy docs
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
# Only one deployment at a time; cancel any in-progress run on new push.
concurrency:
group: pages
cancel-in-progress: true
jobs:
build-and-deploy:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install docs + notebook deps
run: |
pip install \
"pysofra[all]" \
mkdocs-material \
"mkdocstrings[python]" \
jupyter \
nbconvert
- name: Build mkdocs site
run: mkdocs build --strict
- name: Render case-study notebook to HTML
run: |
mkdir -p site/notebooks
jupyter nbconvert \
--to html \
examples/jss_case_study/jss_case_study.ipynb \
--output-dir site/notebooks/ \
--output jss_case_study.html
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: site/
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4