Updated the whatis section of scatterkit #34
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: [main] | |
| tags: ["*"] | |
| pull_request: | |
| # Check all PR | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.14" | |
| check-latest: true | |
| - name: install dependencies | |
| run: python -m pip install tox gitpython | |
| - name: build documentation | |
| run: tox -e docs | |
| - name: Check for Changelog | |
| if: github.event_name == 'pull_request' | |
| run: python ./developer/check_changelog.py | |
| - name: put documentation in the website | |
| run: | | |
| git clone https://github.com/$GITHUB_REPOSITORY --branch gh-pages gh-pages | |
| rm -rf gh-pages/.git | |
| cd gh-pages | |
| REF_KIND=$(echo $GITHUB_REF | cut -d / -f2) | |
| if [[ "$REF_KIND" == "tags" ]]; then | |
| DOC_KIND="stable" | |
| else | |
| DOC_KIND="latest" | |
| fi | |
| rm -rf $DOC_KIND | |
| mv ../docs/build/html $DOC_KIND | |
| - name: deploy to gh-pages | |
| if: github.event_name == 'push' | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./gh-pages/ | |
| force_orphan: true |