Skip to content

Deploy Docs

Deploy Docs #1

Workflow file for this run

name: Deploy Docs
on:
push:
tags:
- 'v*'
workflow_dispatch:
inputs:
ref:
description: "Branch or tag to build docs from"
required: false
default: ""
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout source
uses: actions/checkout@v4
with:
ref: ${{ github.event.inputs.ref || github.ref }}
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[docs]
- name: Compile API
run: |
cd compiler/api && python compiler.py
cd ../errors && python compiler.py
- name: Build docs
run: |
cd compiler/docs && python compiler.py
cd ../..
sphinx-build -b dirhtml docs/source docs/build/html -j auto
- name: Add CNAME for custom domain
run: echo "pyrogram.uf.gs" > docs/build/html/CNAME
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4