Skip to content

Commit

Permalink
ignore api subfolder
Browse files Browse the repository at this point in the history
  • Loading branch information
alchem0x2A committed Nov 19, 2024
1 parent c2d9560 commit bdc76ae
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
11 changes: 8 additions & 3 deletions .github/workflows/publish_doc_pages.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
name: Publish Document Pages for SPARC-X-API

# SPARC source code components are also parsed at each submission
on:
push:
branches:
- master
- 'doc/**'
- 'sparc/**'
pull_request:
branches:
- master
paths:
- 'doc/**'
- 'sparc/**'

workflow_dispatch:

Expand All @@ -34,17 +37,19 @@ jobs:
pip install -e ".[doc]"
- name: Build sphix doc
run: |
sphinx-build doc doc/_build
# sphinx-build doc doc/_build
cd doc
make clean && make html
- 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: doc/_build
publish_dir: doc/_build/html
- name: Upload preview when creating pull request
if: github.event_name == 'pull_request'
uses: actions/upload-artifact@v3
with:
name: docs_build_preview
path: doc/_build
path: doc/_build/html
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -787,3 +787,4 @@ examples/ex1-ase/
/paper/paper.pdf
/paper/jats/
/doc/_build/
/doc/api/

0 comments on commit bdc76ae

Please sign in to comment.