Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update documentation building script to use poetry for installing dependencies #344

Merged
merged 6 commits into from
Apr 7, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions .github/workflows/publish-documentation-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,28 @@
name: Publish documentation to GitHub Pages
name: Publish Documentation to GitHub Pages

on:
workflow_dispatch: # this allows us to run it manually
release:
types: [released]
types: [ released ] # only deploy when we make a new `latest` release

permissions:
contents: write

jobs:
deploy:

build-publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v2

- run: pipx install poetry

- uses: actions/setup-python@v4
with:
python-version: 3.x
- run: pip install mkdocs-material mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index mkdocstrings-python
- run: mkdocs gh-deploy --force
python-version: 3.8
cache: 'poetry'

- name: Install dependencies
run: poetry install

- run: poetry run mkdocs gh-deploy --force