Skip to content

resolve ci/cd pipeline issue #18

resolve ci/cd pipeline issue

resolve ci/cd pipeline issue #18

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Cache pip dependencies
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Build documentation
run: |
export GITHUB_ACTIONS=true
sphinx-build -c . -b dirhtml . _build/html --keep-going -w .sphinx/warnings.txt
- name: Add .nojekyll file
run: |
touch _build/html/.nojekyll
- name: Verify build output
run: |
echo "Build directory structure:"
find _build/html -type f -name "*.html" | head -20
echo "Static files:"
find _build/html/_static -type f | head -10
echo "Index file exists:" && ls -la _build/html/index.html
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: '_build/html'
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/main'
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4