feature: add a new image generation command and refactor of project s… #18
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
name: documentation | |
on: | |
push: | |
branches: | |
- master | |
permissions: | |
contents: write | |
jobs: | |
build-documentation: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@master | |
with: | |
fetch-depth: 0 | |
- name: Install Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: "3.12" | |
- name: Install Poetry | |
uses: snok/install-poetry@v1 | |
with: | |
virtualenvs-create: true | |
virtualenvs-in-project: true | |
virtualenvs-path: .venv | |
installer-parallel: true | |
- name: Install dependencies | |
run: poetry install --no-interaction | |
- name: Build documentation | |
run: | | |
mkdir gh-pages | |
touch gh-pages/.nojekyll | |
poetry run sphinx-apidoc -o docs/ image_transformer/ | |
poetry run sphinx-build -b html docs docs/_build | |
cp -r docs/_build/* ./gh-pages/ | |
- name: Deploy documentation | |
if: ${{ github.event_name == 'push' }} | |
uses: JamesIves/github-pages-deploy-action@4.1.4 | |
with: | |
branch: gh-pages | |
folder: gh-pages |