Skip to content

Deploy Documentation to GitHub Pages #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,17 +99,16 @@ jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
- name: Checkout
uses: actions/checkout@v3.5.3

- name: Install dependencies
- name: Install requirements
run: pip3 install -r docs/requirements.txt

- name: Build documentation
- name: Build with Sphinx
run: sphinx-build -b html docs build/docs -W --keep-going

- name: Upload documentation as artifact
uses: actions/upload-artifact@v3.1.2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1.0.8
with:
name: docs
path: build/docs
39 changes: 39 additions & 0 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: deploy
on:
workflow_dispatch:
push:
branches: [main]
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
docs:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
uses: actions/checkout@v3.5.3

- name: Install requirements
run: pip3 install -r docs/requirements.txt

- name: Setup Pages
uses: actions/configure-pages@v3.0.6

- name: Build with Sphinx
run: sphinx-build -b html docs docs/build -W --keep-going

- name: Upload artifact
uses: actions/upload-pages-artifact@v1.0.8
with:
path: docs/build

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2.0.2
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@
!.clang*
!.cmake*
!.git*
!.readthedocs*

build
10 changes: 0 additions & 10 deletions .readthedocs.yaml

This file was deleted.