Skip to content

Commit

Permalink
update the workdlow
Browse files Browse the repository at this point in the history
  • Loading branch information
Alleria1809 committed Jun 29, 2024
1 parent 6ed5ca3 commit f125a28
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ name: Documentation
on:
push:
branches:
- xiaoyi_doc
workflow_dispatch:
- xiaoyi_doc # Ensure this is the branch where you commit documentation updates
# workflow_dispatch: # Allows manual triggering of the workflow

permissions:
contents: write
Expand All @@ -13,6 +13,7 @@ permissions:
jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4
Expand All @@ -30,14 +31,20 @@ jobs:
- name: Build documentation
run: |
sphinx-build -b html docs/source/ docs/build/
ls -l docs/build/ # List output files for debugging
sphinx-build -b html ./docs/source/ ./docs/build/
ls -l ./docs/build/ # List output files for debugging
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: docs/build/
user_name: github-actions[bot]
publish_branch: gh-pages # Ensure this is the branch for GitHub Pages
publish_dir: ./docs/build/
user_name: github-actions[bot] # Automated commit user name
user_email: github-actions[bot]@users.noreply.github.com

- name: Debug Output
run: |
pwd # Print the current working directory
ls -l # List files in the current directory
cat ./docs/source/conf.py # Show Sphinx config file for debugging

0 comments on commit f125a28

Please sign in to comment.