Skip to content

Commit

Permalink
Update breaking changes from starter-pack and improve workflow
Browse files Browse the repository at this point in the history
- There are recent breaking changes in canonical/sphinx-docs-starter-pack
that causes our workflow to fail. Updated those changes in COU to align.
- Update the workflow to only trigger documentation checks if a PR
modifies `docs/`. This will prevent un-necessary runs. I'm keeping the
on.push as is because I think it is good to have a way to notify us
about dependency breakage (those issues are not affecting live doc site).
  • Loading branch information
agileshaw committed Jan 16, 2024
1 parent f8ec12f commit bc7d3a3
Show file tree
Hide file tree
Showing 6 changed files with 242 additions and 180 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/automatic-doc-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ name: Main Documentation Checks
on:
- push
- pull_request
paths:
- 'docs/**'
- workflow_dispatch

concurrency:
Expand Down
3 changes: 2 additions & 1 deletion docs/.custom_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@ OpenStackApplication
yaml
backoff
BACKOFF
websockets
websockets
enablement
6 changes: 3 additions & 3 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ serve: html
clean: clean-doc
@test ! -e "$(VENVDIR)" -o -d "$(VENVDIR)" -a "$(abspath $(VENVDIR))" != "$(VENVDIR)"
rm -rf $(VENVDIR)
rm -rf .sphinx/.doctrees

clean-doc:
git clean -fx "$(BUILDDIR)"
rm -rf .sphinx/.doctrees

spelling: html
. $(VENV) ; python3 -m pyspelling -c .sphinx/spellingcheck.yaml
Expand All @@ -93,9 +93,9 @@ woke: woke-install
-c https://github.com/canonical/Inclusive-naming/raw/main/config.yml

pa11y: pa11y-install html
find $(BUILDDIR) -name *.html -exec $(PA11Y) {} \;
find $(BUILDDIR) -name *.html -print0 | xargs -n 1 -0 $(PA11Y)

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
. $(VENV); $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
. $(VENV); $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
59 changes: 0 additions & 59 deletions docs/help-woke.rst

This file was deleted.

Loading

0 comments on commit bc7d3a3

Please sign in to comment.