Skip to content

Commit

Permalink
feat: add a docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
jolars committed Nov 29, 2023
1 parent 61170d5 commit 7981b47
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/build-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: build-docs
on:
push:
branches: [main]

workflow_dispatch:

permissions:
contents: write
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4

- name: Install python dependencies
run: python -m pip install sphinx sphinx-rtd-theme sphinx-sitemap

- name: Build documentation
run: |
sphinx-apidoc -o docs/source sortedl1
cd docs
make html
- name: Setup pages
uses: actions/configure-pages@v3

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: "docs/build/html/"

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

0 comments on commit 7981b47

Please sign in to comment.