mirror of
https://github.com/TheAlgorithms/Python.git
synced 2024-12-05 02:40:16 +00:00
51 lines
1.4 KiB
YAML
51 lines
1.4 KiB
YAML
|
name: sphinx
|
||
|
|
|
||
|
|
on:
|
||
|
|
# Triggers the workflow on push or pull request events but only for the "master" branch
|
||
|
|
push:
|
||
|
|
branches: ["master"]
|
||
|
|
pull_request:
|
||
|
|
branches: ["master"]
|
||
|
|
# Or manually from the Actions tab
|
||
|
|
workflow_dispatch:
|
||
|
|
|
||
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
||
|
|
permissions:
|
||
|
|
contents: read
|
||
|
|
pages: write
|
||
|
|
id-token: write
|
||
|
|
|
||
|
|
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
||
|
|
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
||
|
|
concurrency:
|
||
|
|
group: "pages"
|
||
|
|
cancel-in-progress: false
|
||
|
|
|
||
|
|
jobs:
|
||
|
|
build_docs:
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
steps:
|
||
|
|
- uses: actions/checkout@v4
|
||
|
|
- uses: actions/setup-python@v5
|
||
|
|
with:
|
||
|
|
python-version: 3.13
|
||
|
|
allow-prereleases: true
|
||
|
|
- run: pip install --upgrade pip
|
||
|
|
- run: pip install myst-parser sphinx-autoapi sphinx-pyproject
|
||
|
|
- uses: actions/configure-pages@v5
|
||
|
|
- run: sphinx-build -c docs . docs/_build/html
|
||
|
|
- uses: actions/upload-pages-artifact@v3
|
||
|
|
with:
|
||
|
|
path: docs/_build/html
|
||
|
|
|
||
|
|
deploy_docs:
|
||
|
|
environment:
|
||
|
|
name: github-pages
|
||
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
||
|
|
if: github.event_name != 'pull_request'
|
||
|
|
needs: build_docs
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
steps:
|
||
|
|
- uses: actions/deploy-pages@v4
|
||
|
|
id: deployment
|