chore(deps): bump requests from 2.32.5 to 2.33.0 in /docs #413
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
| name: Documentation | |
| on: | |
| push: | |
| branches: ['**'] # Build on all branches | |
| pull_request: | |
| branches: ['**'] | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-docs-${{ hashFiles('docs/requirements.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip-docs- | |
| - name: Install system dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y libhdf5-dev pkg-config | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip wheel | |
| # Install pytables separately if needed by the package | |
| pip install --verbose tables | |
| pip install -r docs/requirements.txt | |
| pip install -e . | |
| - name: Lint documentation with doc8 | |
| run: doc8 README.rst docs CITATION.rst --max-line-length=100 --ignore-path docs/source/solarwindpy.solar_activity.tests.rst | |
| - name: Check documentation links | |
| run: | | |
| pip install sphinx-link-checker | |
| sphinx-build -b linkcheck docs docs/build/linkcheck | |
| continue-on-error: true | |
| - name: Build documentation | |
| env: | |
| SPHINXOPTS: -W --keep-going -n # Warnings as errors, but show all | |
| working-directory: docs | |
| run: | | |
| make clean | |
| make html | |
| - name: Upload documentation artifacts | |
| if: always() | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: documentation-${{ github.run_id }} | |
| path: | | |
| docs/build/html/ | |
| docs/build/doctrees/ | |
| docs/build/coverage/ | |
| docs/build/linkcheck/ | |
| retention-days: 90 | |
| - name: Check documentation coverage | |
| run: | | |
| mkdir -p docs/build/coverage | |
| python -m sphinx.ext.coverage -d docs/build/doctrees -o docs/build/coverage docs | |
| # Generate a summary report | |
| echo "Documentation Coverage Summary:" > docs/build/coverage/summary.txt | |
| find docs/build/coverage -name "*.txt" -exec cat {} \; >> docs/build/coverage/summary.txt | |
| continue-on-error: true | |
| deploy: | |
| needs: build | |
| if: github.ref == 'refs/heads/master' && github.event_name == 'push' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install system dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y libhdf5-dev pkg-config | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip wheel | |
| # Install pytables separately if needed by the package | |
| pip install --verbose tables | |
| pip install -r docs/requirements.txt | |
| pip install -e . | |
| - name: Build documentation for deployment | |
| working-directory: docs | |
| run: | | |
| make clean | |
| make html | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/build/html | |
| cname: solarwindpy.github.io # If you have a custom domain |