DOC: add documentation about using shared libraries #641
Workflow file for this run
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
# SPDX-FileCopyrightText: 2022 The meson-python developers | |
# | |
# SPDX-License-Identifier: MIT | |
name: docs | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- docs/** | |
- CHANGELOG.rst | |
- README.md | |
pull_request: | |
branches: | |
- main | |
- release-* | |
paths: | |
- docs/** | |
- CHANGELOG.rst | |
- README.md | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
- uses: actions/checkout@v4 | |
with: | |
ref: ${{ github.event.inputs.tag || github.ref }} | |
- run: python -m pip install .[docs] | |
- run: python -m sphinx -W docs/ build/docs/ | |
- uses: actions/upload-pages-artifact@v3 | |
with: | |
path: build/docs/ | |
deploy: | |
needs: build | |
permissions: | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
runs-on: ubuntu-latest | |
if: ${{ github.ref == 'refs/heads/main' }} | |
steps: | |
- uses: actions/deploy-pages@v4 |