-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5f0e900
commit 47bbf34
Showing
2 changed files
with
48 additions
and
1 deletion.
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,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 |
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