From 20a04a75da40609c0b00293088f34e3e14c56264 Mon Sep 17 00:00:00 2001 From: Bengt Ljungquist Date: Mon, 8 Jan 2024 11:59:00 -0500 Subject: [PATCH] Corrected documentation generation (#7) * Added packages * cleaned up example * Commit test * Added pre-commit hooks * Formatting * Updated example * Update package * Added multilevel metadata test * Bump version 0.1.8 -> 0.1.9 * Added mkdocstrings pip * Added trigger * Added handler --------- Co-authored-by: Nicholas-Schaub --- .github/workflows/ci.yml | 49 +++++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 716620d..5d021de 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,23 +1,26 @@ - name: ci - on: - push: - branches: - - master - - main - permissions: - contents: write - jobs: - deploy: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: actions/setup-python@v4 - with: - python-version: 3.x - - uses: actions/cache@v2 - with: - key: ${{ github.ref }} - path: .cache - - run: pip install mkdocs-material - - run: pip install pillow cairosvg - - run: mkdocs gh-deploy --force \ No newline at end of file +name: ci +on: + push: + branches: + - master + - main + - update-docs +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: 3.x + - uses: actions/cache@v2 + with: + key: ${{ github.ref }} + path: .cache + - run: pip install mkdocs-material + - run: pip install pillow cairosvg + - run: pip install mkdocstrings + - run: pip install mkdocstrings-python + - run: mkdocs gh-deploy --force