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

Update breaking changes from starter-pack and improve workflow #220

Merged
merged 2 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
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
9 changes: 6 additions & 3 deletions .github/workflows/automatic-doc-checks.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
name: Main Documentation Checks

on:
- push
- pull_request
- workflow_dispatch
push:
pull_request:
paths:
- 'docs/**'
workflow_dispatch:


concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
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
4 changes: 2 additions & 2 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,7 +93,7 @@ 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).
Expand Down
59 changes: 0 additions & 59 deletions docs/help-woke.rst

This file was deleted.

Loading
Loading