-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: deploy Sphinx Documentation automatically to gh-pages using Git…
…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
Showing
3 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
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
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 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
etalk.eventyay.com |
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