-
Notifications
You must be signed in to change notification settings - Fork 0
112 lines (106 loc) · 3.92 KB
/
sphinx.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
##########################################################################################
# DESCRIPTION: Generate Sphinx and pushes them to Git Pages.
# AUTHOR: W. Li
# VERSION: 1.0
# CREATED: 5/23/2024
#
# References:
# * https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-pythonCommon
#
##########################################################################################
name: sphinx
on:
push:
branches: ["main"]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
##########################################################################################
# Jobs
##########################################################################################
jobs:
########################################################################################
# Build the static HTML files we want to publish.
########################################################################################
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
steps:
# Checkout the source repo
- name: Checkout source
uses: actions/checkout@v4
# Setup the environment with specified python version
- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
token: ${{ secrets.GH_GITHUB_COM_TOKEN }}
python-version: "3.10"
# Setup Homebrew
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
- name: Install Homebrew packages
run: brew install allure
# Install poetry and disable virtual environments
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: false
virtualenvs-in-project: false
installer-parallel: true
# Install nox
- name: Install dependencies
run: |
pip install nox
# Use nox to generate the document
- name: Generate Sphinx artifacts
run: |
export PYTHONPATH=${{ github.workspace }}
nox -r -s build
# Upload the artifact to the next job
- name: Upload Sphinx artifact
uses: actions/upload-artifact@v4
with:
name: Sphinx artifact
path: docs/build/html/
########################################################################################
# Deploy the static HTML files to Github Pages.
########################################################################################
deploy:
needs: [build]
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
# We first need to checkout the repo for the code.
- name: Checkout
uses: actions/checkout@v4
# Now download the artifact from the previous build for Sphinx.
- name: Download Sphinx artifact
uses: actions/download-artifact@v4
with:
name: Sphinx artifact
path: docs/build/html/
# Note: Github pages expects all of your HTML static files to reside in docs/
- name: Display structure of downloaded files
run: ls -al
working-directory: docs/build/html/
# We are now ready to upload the artifact folder to Github pages.
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html/
# Once the upload is complete we can deploy
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4