Skip to content

Add Sphinx-based documentation #6

Add Sphinx-based documentation

Add Sphinx-based documentation #6

Workflow file for this run

---
name: "Pages"
concurrency:
group: "pages"
cancel-in-progress: true
on:
push:
jobs:
"pages-build":
runs-on: "ubuntu-22.04"
steps:
- name: "Checkout"
uses: "actions/checkout@v4" # tested with v4.0.0
# Use micromamba instead of conda for better performance
- name: "Setup conda environment with micromamba"
uses: "mamba-org/setup-micromamba@v1" # tested with v1.4.4
with:
environment-file: "conda-environment-dev.yml"
- name: "Install dependencies with Poetry"
run: "${MAMBA_EXE} run --name mxcubecore poetry install"
- name: "Build documentation with Sphinx"
run: "${MAMBA_EXE} run --name mxcubecore make --directory=./docs/ html"
- name: "Upload artifact for GitHub Pages"
# This could potentially be run only when we intent to deploy...
# ...but it can be useful to have the artifact for debugging
# if: "github.ref_name == github.event.repository.default_branch"
uses: "actions/upload-pages-artifact@v2" # tested with v2.0.0
with:
path: "docs/build/html"
"pages-deploy":
if: "github.ref_name == github.event.repository.default_branch"
environment:
name: "github-pages"
url: "${{ steps.deployment.outputs.page_url }}"
needs:
- "pages-build"
permissions:
pages: "write"
id-token: "write"
runs-on: "ubuntu-22.04"
steps:
- name: "Setup GitHub Pages"
uses: "actions/configure-pages@v3" # tested with v3.0.6
- name: "Deploy to GitHub Pages"
id: "deployment"
uses: "actions/deploy-pages@v2" # tested with 2.0.4
... # EOF