fix the grammar error at readme #129
This file contains 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
| name: Documentation | |
| on: | |
| push: | |
| branches: | |
| - li # Trigger the workflow when changes are pushed to the release branch | |
| permissions: | |
| contents: write | |
| actions: read | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # Fetch all history for all branches and tags | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' # Ensure the Python version is correct | |
| - name: Install Poetry | |
| run: | | |
| curl -sSL https://install.python-poetry.org | python3 - | |
| echo "$HOME/.local/bin" >> $GITHUB_PATH # Ensure Poetry's bin directory is in PATH | |
| - name: Install documentation dependencies using Poetry | |
| run: | | |
| cd docs | |
| poetry config virtualenvs.create false # Avoid creating a virtual environment | |
| poetry install # Install only the doc dependencies as specified in pyproject.toml | |
| - name: Build documentation using Makefile | |
| run: | | |
| echo "Building documentation from: $(pwd)" | |
| ls -l # Debug: List current directory contents | |
| poetry run make html # Run Makefile in docs directory to build HTML docs | |
| working-directory: ${{ github.workspace }}/docs | |
| - name: List built documentation | |
| run: | | |
| find ./docs/build/ -type f # List all files in the build directory | |
| working-directory: ${{ github.workspace }} | |
| - name: Create .nojekyll file | |
| run: | | |
| touch .nojekyll # Prevent GitHub Pages from ignoring files that start with an underscore | |
| working-directory: ${{ github.workspace }}/docs/build | |
| - name: Copy CNAME file | |
| run: | | |
| cp ${{ github.workspace }}/CNAME ${{ github.workspace }}/docs/build/CNAME || true | |
| working-directory: ${{ github.workspace }} | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} # GitHub token for authentication | |
| publish_branch: gh-pages # Target branch for GitHub Pages deployment | |
| publish_dir: ./docs/build/ # Directory containing the built documentation | |
| user_name: github-actions[bot] # Username for the commit | |
| user_email: github-actions[bot]@users.noreply.github.com # Email for the commit | |
| # Uncomment below for debugging purposes | |
| # - name: Debug Output | |
| # run: | | |
| # pwd # Print the current working directory | |
| # ls -l ./build/ # List files in the build directory | |
| # cat ./source/conf.py # Display the Sphinx configuration file | |
| # working-directory: ${{ github.workspace }}/docs/build |