Skip to content

Commit

Permalink
doc: update documentation checks
Browse files Browse the repository at this point in the history
We should really use the reusable workflows, but this is currently
not possible since we require some non-standard processing.
Therefore, keep the current checks and update them to the latest
framework.

Also, build the docs first and then run the spellcheck on the
docs that are already built (instead of building again).

Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
  • Loading branch information
ru-fu committed Jun 4, 2024
1 parent a561bf1 commit b608fae
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,12 @@ jobs:
set -eux
make doc-lint
- name: Build docs (Sphinx)
run: |
set -eux
make doc
if [ -s doc/.sphinx/warnings.txt ]; then cat doc/.sphinx/warnings.txt; exit 1; fi
- name: Run spell checker
run: |
set -eux
Expand All @@ -510,18 +516,12 @@ jobs:
set -eux
make doc-linkcheck
- name: Build docs (Sphinx)
run: |
set -eux
make doc
if [ -s doc/.sphinx/warnings.txt ]; then cat doc/.sphinx/warnings.txt; exit 1; fi
- name: Upload documentation artifacts
if: always()
uses: actions/upload-artifact@v4
with:
name: documentation
path: doc/html
path: doc/_build

snap:
name: Trigger snap edge build
Expand Down

0 comments on commit b608fae

Please sign in to comment.