Skip to content

Add --nox, export before tests #16

Add --nox, export before tests

Add --nox, export before tests #16

Workflow file for this run

name: Deploy pdoc
on:
push:
branches: main
permissions:
contents: read
concurrency:
group: pdoc
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install package
run: pip install -e .[pdoc] hatch
- name: Generate docs
timeout-minutes: 1
run: |
pdoc hexdoc \!hexdoc._cli \!hexdoc._export \!hexdoc._templates \
--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 "Version: $(hatch version) ($(git rev-parse --short HEAD))" \
--logo https://github.com/object-Object/hexdoc/raw/main/media/hexdoc.svg \
--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