Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initialize gh pages doc configuration #65

Merged
merged 8 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/workflows/publish_doc_pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Publish Document Pages for SPARC-X-API

on:
push:
branches:
- master
- 'docs/**'
pull_request:
branches:
- master
paths:
- 'docs/**'

workflow_dispatch:

jobs:
sphinx-build:
defaults:
run:
shell: bash -l {0}
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: conda-incubator/setup-miniconda@v3
with:
python-version: "3.11"
mamba-version: "*"
channels: conda-forge,defaults
channel-priority: true
activate-environment: sparc-api-build-doc
- name: Install doc-build dependencies
run: |
pip install -e ".[doc]"
- name: Build sphix doc
run: |
sphinx-build docs docs/_build
- name: Deploy to github pages
uses: peaceiris/actions-gh-pages@v4
if: github.ref == 'refs/heads/master' && github.event_name == 'push'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh_pages
publish_dir: docs/_build
- name: Upload preview when creating pull request
if: github.event_name == 'pull_request'
uses: actions/upload-artifact@v3
with:
name: docs_build_preview
path: docs/_build
Loading
Loading