Skip to content

fix: filter out build dir from Vale checks #605

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.

Sign up for GitHub

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

Merged
dwilding merged 3 commits into from
May 25, 2026
Merged

fix: filter out build dir from Vale checks #605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa90626
filter out build dir from vale checks
dwilding May 21, 2026
676c5ea
mention the fix in the changelog
dwilding May 25, 2026
1ae85cf
change title of the changelog
dwilding May 25, 2026
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
12 changes: 10 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# sphinx-docs-starter-pack changelog
# sphinx-stack changelog

## Upcoming

* Prevent Vale from processing Markdown files in the build directory
* Update link to documenation in README

### Changed

* `docs/Makefile` [#605](https://github.com/canonical/sphinx-stack/pull/605)
* `README.md` [#603](https://github.com/canonical/sphinx-stack/pull/603)

## 2.0

* Add an `AUTOBUILD_EXTRA_OPTS` variable to extend sphinx-autobuild options for `make run`
* Add default support for the sphinx-llm extension
* Pin dependencies to major versions
Expand All @@ -13,7 +22,6 @@

### Changed

* `README.md` [#603](https://github.com/canonical/sphinx-stack/pull/603)
* `docs/conf.py` [#562](https://github.com/canonical/sphinx-docs-starter-pack/pull/562), [#576](https://github.com/canonical/sphinx-docs-starter-pack/pull/576), [#590](https://github.com/canonical/sphinx-docs-starter-pack/pull/590), [#595](https://github.com/canonical/sphinx-docs-starter-pack/pull/595), [#598](https://github.com/canonical/sphinx-docs-starter-pack/pull/598)
* `docs/Makefile` [#575](https://github.com/canonical/sphinx-docs-starter-pack/pull/575), [#590](https://github.com/canonical/sphinx-docs-starter-pack/pull/590)
* `docs/requirements.txt` [#590]([#590](https://github.com/canonical/sphinx-docs-starter-pack/pull/590))
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ VALE_DIR ?= $(DOCS_VENVDIR)/lib/python*/site-packages/vale
VALE_CONFIG ?= $(DEV_DIR)/vale.ini
PA11Y_CMD ?= $(DEV_DIR)/node_modules/pa11y/bin/pa11y.js --config $(DEV_DIR)/pa11y.json
CONFIRM_SUDO ?= N
CHECK_PATH ?= $(filter-out $(DOCS_VENVDIR),$(wildcard *))
CHECK_PATH ?= $(filter-out $(DOCS_VENVDIR) $(DOCS_BUILDDIR),$(wildcard *))

# Put it first so that "make" without argument is like "make help".
help:
Expand Down
Loading