Skip to content

Commit 56d3bcc

Browse files
Update documentation.yml
1 parent bff1492 commit 56d3bcc

File tree

1 file changed

+41
-21
lines changed

1 file changed

+41
-21
lines changed

.github/workflows/documentation.yml

Lines changed: 41 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,47 @@
1-
name: "Perceptions Library 22a"
1+
# This is a basic workflow to help you get started with Actions
22

3-
on: push
3+
name: Perceptions Library 22a
44

5+
# Controls when the workflow will run
6+
on:
7+
# Triggers the workflow on push or pull request events but only for the main branch
8+
push:
9+
branches: [DocumentationBranch]
10+
pull_request:
11+
branches: [DocumentationBranch]
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
517
jobs:
18+
# This workflow contains a single job called "build"
619
build:
20+
# The type of runner that the job will run on
721
runs-on: ubuntu-latest
8-
permissions:
9-
contents: write
22+
23+
# Steps represent a sequence of tasks that will be executed as part of the job
1024
steps:
11-
- uses: actions/checkout@v4
12-
- name: Build HTML
13-
uses: ammaraskar/sphinx-action@master
14-
with:
15-
docs-folder: "documentation/html"
16-
build-command: "sphinx-build -b html source build"
17-
- name: Upload artifacts
18-
uses: actions/upload-artifact@v4
19-
with:
20-
name: html-docs
21-
path: documentation/html/build/html/
22-
- name: Deploy
23-
uses: peaceiris/actions-gh-pages@v3
24-
if: github.ref == 'refs/heads/main'
25-
with:
26-
github_token: ${{ secrets.GITHUB_TOKEN }}
27-
publish_dir: documentation/html/build/html
25+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
26+
- uses: actions/checkout@v2
27+
28+
- name: Set up Python 3.10
29+
uses: actions/setup-python@v2
30+
with:
31+
python-version: "3.10"
32+
# Runs a single command using the runners shell
33+
- name: Run a one-line script
34+
run: echo Hello, world!
35+
36+
- name: Install dependencies
37+
run: |
38+
python -m pip install --upgrade pip
39+
# pip install -r requirements.txt
40+
- name: Build HTML
41+
run: |
42+
cd documentation/html
43+
clean html
44+
make html
45+
- name: Run ghp-import
46+
run: |
47+
ghp-import -n -p -f documentation/html/_build/html

0 commit comments

Comments
 (0)