Skip to content

Commit

Permalink
ci: Build/deploy documentation
Browse files Browse the repository at this point in the history
Add a CI job to build and deploy our API documentation.

Signed-off-by: Sean Anderson <[email protected]>
  • Loading branch information
Forty-Bot committed Nov 20, 2023
1 parent 3f45b24 commit 90f959f
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Build and deploy documentation

on:
push:
branches:
- master
workflow_dispatch:

permissions:
contents: read

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

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: pip install '.[doc,flask]'
- uses: actions/configure-pages@v2
- run: make htmldocs
- uses: actions/upload-pages-artifact@v1
with:
path: doc/out/html

deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- id: deployment
uses: actions/deploy-pages@v1
4 changes: 4 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ def build_extension(self, ext):
'prometheus_client',
],
extras_require = {
"doc": [
'sphinx',
'sphinx-rtd-theme',
],
"flask": [
'prometheus_flask_exporter',
],
Expand Down

0 comments on commit 90f959f

Please sign in to comment.