Skip to content

new environment for 2024-3 cycle #135

new environment for 2024-3 cycle

new environment for 2024-3 cycle #135

Workflow file for this run

name: Publish Sphinx docs to GitHub Pages
# see: https://github.com/marketplace/actions/sphinx-to-github-pages
on:
# Build the docs on pushes to main branch, PRs to main branch, and new tags.
# Publish only on demand.
push:
branches:
- main
tags:
- '*' # all tags
pull_request:
branches:
- main
workflow_dispatch: # allow manual triggering
inputs:
deploy:
description: 'Deploy documentation'
type: boolean
required: true
default: false
defaults:
run:
shell: bash -l {0}
jobs:
pages:
name: Publish documentation
runs-on: ubuntu-latest
steps:
- name: Deploy Information
if: ${{ github.event.inputs.deploy }}
run: |
echo "The docs will be published from this workflow run."
- name: Install pandoc
run: |
sudo apt-get update && \
sudo apt-get -y install pandoc
- name: Set time zone
run: echo "TZ=America/Chicago" >> "$GITHUB_ENV"
- name: Sphinx build
id: deployment
uses: sphinx-notes/pages@v3
with:
documentation_path: ./docs/source
publish: false
requirements_path: ./docs/requirements.txt
- name: Diagnostic
run: ls -lAFgh ${{ steps.deployment.outputs.artifact }}
- name: Upload Docs ZIP file as artifact
uses: actions/upload-artifact@v4
with:
name: bluesky_training-docs
path: ${{ steps.deployment.outputs.artifact }}
- uses: peaceiris/actions-gh-pages@v4
if: ${{ github.event.inputs.deploy }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ${{ steps.deployment.outputs.artifact }}