Skip to content

Commit e4ac4ce

Browse files
authored
Merge pull request #105 from PyORBIT-Collaboration/docs/deploy-to-pages-workflow
Adds documentation generation and uploading to github pages.
2 parents 00edf0a + 1391158 commit e4ac4ce

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Simple workflow for deploying static content to GitHub Pages
2+
name: Deploy Documentation to Pages
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches: ["main"]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
# Single deploy job since we're just deploying
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
- uses: conda-incubator/setup-miniconda@v2
35+
with:
36+
activate-environment: po3
37+
environment-file: docs-environment.yml
38+
- uses: ammaraskar/sphinx-action@master
39+
with:
40+
docs-folder: "doc/"
41+
# - name: Setup Pages
42+
# uses: actions/configure-pages@v5
43+
- name: Upload artifact
44+
uses: actions/upload-pages-artifact@v3
45+
with:
46+
# Upload entire repository
47+
path: './doc/build/html'
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)