Skip to content

Commit

Permalink
feat: deploy Sphinx Documentation automatically to gh-pages using Git…
Browse files Browse the repository at this point in the history
…Hub Actions (#260)

* Add GitHub Actions workflow for documentation deployment

* fix: gitHub cctions workflow for doc deployment

* fix: pip deps issue in gh actions workflow for doc deployment

* fix: py version deps mismatch in gh actions workflow for doc deployment

* add GitHub Actions workflow for documentation deployment

* add doc deployment workflow

* add CNAME

* add CNAME to MANIFEST.in
  • Loading branch information
r3yc0n1c authored Jan 19, 2025
1 parent bc1cc16 commit a7ae7c2
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Deploy Sphinx Documentation to GitHub Pages

on:
push:
branches:
- deployment # Adjust this to your default branch

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
cache: 'pip'

- name: Install system packages
run: sudo apt update && sudo apt install libffi-dev gettext

- name: Install dependencies
run: pip install --upgrade-strategy eager -Ur doc/requirements.txt

- name: Build documentation
run: make html
working-directory: doc # Adjust to your Sphinx docs directory

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/_build/html
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
etalk.eventyay.com
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
include _build/backend.py
include LICENSE
include CNAME
include README.rst
include src/pretalx.example.cfg
include Dockerfile
Expand Down

0 comments on commit a7ae7c2

Please sign in to comment.