Skip to content

Commit

Permalink
Add pdoc workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
object-Object committed Nov 5, 2023
1 parent 5f0e900 commit 47bbf34
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 1 deletion.
44 changes: 44 additions & 0 deletions .github/workflows/pdoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Deploy pdoc

on:
push:
branches: main

permissions:
contents: read

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.11'

- run: pip install -e .[pdoc] hatch
- run: |-
pdoc hexdoc
--edit-url hexdoc=https://github.com/object-Object/hexdoc/blob/main/src/hexdoc/
--favicon https://github.com/object-Object/hexdoc/raw/main/media/hexdoc.png
--footer-text "hexdoc $(hatch version) ($(git rev-parse --short HEAD))"
--logo https://github.com/object-Object/hexdoc/raw/main/media/hexdoc.png
--logo-link https://pypi.org/project/hexdoc/
--output-directory docs/
- uses: actions/upload-pages-artifact@v2
with:
path: docs/

deploy:
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v2
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,16 @@ favicons = [
# TODO: move this back to the main deps list when they fix the dependency conflict
"favicons~=0.2",
]
pdoc = [
"pdoc~=14.1",
]
test = [
"pytest~=7.4",
"pytest-dependency~=0.5.1",
"syrupy~=4.6",
]
dev = [
"hexdoc[test]",
"hexdoc[favicons,pdoc,test]",
"black==23.7.0",
"isort==5.12.0",
"hatch",
Expand Down

0 comments on commit 47bbf34

Please sign in to comment.