Merge pull request #23 from pangpang20/master #27
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: Build documentation | |
| on: | |
| push: | |
| # This should disable running the workflow on tags, according to the | |
| # on.<push|pull_request>.<branches|tags> GitHub Actions docs. | |
| branches: | |
| - "*" | |
| pull_request: | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref_name }} | |
| cancel-in-progress: true | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.9 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.9" | |
| - name: Install requirements to generate docs | |
| run: sudo apt-get install -y libgeos-dev | |
| - name: Install Python packages to generate docs | |
| run: | | |
| pip install furo | |
| pip install ./tools/isort-gaussdb/ | |
| pip install ./gaussdb[dev,test] | |
| pip install ./gaussdb_pool | |
| pip install types-polib | |
| - name: Check documentation | |
| run: sphinx-build -W -T -b html docs docs/_build/html | |
| - name: Upload built documentation as artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: gaussdb-docs-html | |
| path: docs/_build/html |