From aa906264ee8de9404912a5e2048deb89884474a6 Mon Sep 17 00:00:00 2001 From: David Wilding Date: Thu, 21 May 2026 11:35:59 +0800 Subject: [PATCH 1/3] filter out build dir from vale checks --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index 07e7d4b9..ebe94703 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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: From 676c5eaede2447d02dda8d4307523abff04ca0af Mon Sep 17 00:00:00 2001 From: David Wilding Date: Mon, 25 May 2026 15:32:03 +0800 Subject: [PATCH 2/3] mention the fix in the changelog --- CHANGELOG.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f59db621..a7360315 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,16 @@ ## 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 @@ -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)) From 1ae85cf6d8d05867bb11d6d66c7187856dc57dba Mon Sep 17 00:00:00 2001 From: David Wilding Date: Mon, 25 May 2026 15:32:26 +0800 Subject: [PATCH 3/3] change title of the changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a7360315..b060ba18 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# sphinx-docs-starter-pack changelog +# sphinx-stack changelog ## Upcoming