-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
27 changed files
with
598 additions
and
149 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
--- | ||
|
||
|
||
name: "Pages" | ||
|
||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: true | ||
|
||
on: | ||
push: | ||
|
||
jobs: | ||
|
||
"pages-build": | ||
|
||
runs-on: "ubuntu-22.04" | ||
|
||
services: | ||
|
||
# The Redis server is necessary to run the app, | ||
# which is necessary to get the Flask routes with `autoflask` directives | ||
redis: | ||
image: "redis" | ||
options: >- | ||
--health-cmd "redis-cli ping" | ||
--health-interval 10s | ||
--health-timeout 5s | ||
--health-retries 5 | ||
ports: | ||
- "6379:6379/tcp" | ||
|
||
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.yml" | ||
|
||
- name: "Install dependencies with Poetry" | ||
run: "${MAMBA_EXE} run --name mxcubeweb poetry install" | ||
|
||
- name: "Build documentation with Sphinx" | ||
run: "${MAMBA_EXE} run --name mxcubeweb 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,31 @@ | ||
--- | ||
|
||
|
||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the OS, Python version and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
os: "ubuntu-22.04" | ||
tools: | ||
python: "3.11" | ||
# You can also specify other tool versions: | ||
# nodejs: "19" | ||
# rust: "1.64" | ||
# golang: "1.19" | ||
python: "mambaforge-22.9" | ||
|
||
# Build documentation in the "docs/" directory with Sphinx | ||
sphinx: | ||
configuration: docs/conf.py | ||
# TODO jobs: | ||
# TODO post_install: | ||
# TODO - "mamba run poetry install" | ||
|
||
commands: | ||
- "mamba env create --file conda-environment.yml" | ||
- "mamba run --name mxcubeweb poetry install" | ||
- "(redis-server &) && BUILDDIR=${READTHEDOCS_OUTPUT} mamba run --name mxcubeweb make --directory=./docs/ html && redis-cli shutdown" | ||
|
||
# Optionally build your docs in additional formats such as PDF and ePub | ||
# formats: | ||
# - epub | ||
# TODO conda: | ||
# TODO environment: "conda-environment.yml" | ||
|
||
sphinx: | ||
configuration: "docs/conf.py" | ||
|
||
# Optional but recommended, declare the Python requirements required | ||
# to build your documentation | ||
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
# python: | ||
# install: | ||
# - requirements: docs/requirements.txt | ||
|
||
... # EOF |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.