mirror of
https://github.com/TheAlgorithms/Python.git
synced 2025-01-31 06:33:44 +00:00
91ebea1d99
* Speed up our Sphinx GitHub Action with ARM # `runs-on: ubuntu-24.04-arm` https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources * updating DIRECTORY.md --------- Co-authored-by: cclauss <cclauss@users.noreply.github.com>
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-24.04-arm
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: astral-sh/setup-uv@v5
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
python-version: 3.13
|
|
allow-prereleases: true
|
|
- run: uv sync --group=docs
|
|
- uses: actions/configure-pages@v5
|
|
- run: uv 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
|