Merge pull request #47 from plone/fix-suppress_warnings-syntax

Fix `suppress_warnings` syntax for `SPHINXOPTS`
plone · Dec 5, 2024 · 82550ca · 82550ca
2 parents 9f4ef86 + 11ecef5
commit 82550ca
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/guides/contribute.md b/docs/guides/contribute.md
@@ -81,7 +81,7 @@ make SPHINXOPTS="OPTION VALUE" BUILDER
 The following example shows how to clean then build a live HTML preview of the documentation while suppressing syntax highlighting failures.
 
 ```shell
-make SPHINXOPTS="-D suppress_warnings=['misc.highlighting_failure']" clean livehtml
+make SPHINXOPTS="-D suppress_warnings='misc.highlighting_failure'" clean livehtml
 ```
 
 You can also pass options to vale in the `VALEOPTS` environment variable.

diff --git a/news/47.documentation b/news/47.documentation
@@ -0,0 +1 @@
+Fix `suppress_warnings` syntax for `SPHINXOPTS`. @stevepiercy
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fix `suppress_warnings` syntax for `SPHINXOPTS`. @stevepiercy