Fix comprehensive CI/CD pipeline issues and repository cleanup #60
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Python Auto Documentation | |
| # This workflow auto-generates documentation using Sphinx | |
| name: Python Auto Documentation | |
| permissions: | |
| contents: read | |
| on: | |
| push: | |
| paths: | |
| - '**.py' | |
| pull_request: | |
| paths: | |
| - '**.py' | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Setup Python Environment | |
| uses: ./.github/actions/setup-python-env | |
| with: | |
| python-version: '3.11' | |
| install-dev-reqs: 'false' | |
| install-docs-reqs: 'true' | |
| - name: Generate Sphinx docs | |
| run: | | |
| # Generate API documentation, excluding conf.py | |
| sphinx-apidoc -o doc/codeDocs/ src/ --force --no-toc --module-first | |
| # Build the documentation | |
| sphinx-build -W -b html doc/codeDocs/ doc/codeDocs/_build/html | |
| - name: Upload documentation artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: sphinx-docs | |
| path: doc/codeDocs/_build/html |