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.

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

Fix suppress_warnings syntax for SPHINXOPTS #47

Merged
merged 2 commits into from
Dec 5, 2024
Merged

Fix suppress_warnings syntax for SPHINXOPTS #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f636ff
Fix `suppress_warnings` syntax for `SPHINXOPTS`
stevepiercy Dec 5, 2024
11ecef5
news
stevepiercy Dec 5, 2024
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
2 changes: 1 addition & 1 deletion docs/guides/contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions news/47.documentation
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix `suppress_warnings` syntax for `SPHINXOPTS`. @stevepiercy
Loading