Skip to content

Commit 2f18d34

Browse files
authored
Enable strict mode in myst build (#330)
* Enable strict docs build Catch errors in PRs before they go live! * Downgrade link resolution errors for Google to warnings * Downgrade link resolution checks for Bloomberg to warnings
1 parent a509045 commit 2f18d34

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/myst.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,13 @@ project:
8787
- file: bootstrapping_subproject_councils.md
8888
- file: bootstrapping_executive_council.md
8989

90+
error_rules:
91+
- rule: "link-resolves"
92+
keys:
93+
- "https://google.com/"
94+
- "https://www.bloomberg.com"
95+
severity: "warn"
96+
9097
site:
9198
template: book-theme
9299
options:

noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ def docs(session):
1212
session.install("-r", "requirements.txt")
1313
session.chdir("docs")
1414
session.run("npm", "install", external=True)
15-
session.run("myst", "build", "--html")
15+
session.run("myst", "build", "--strict", "--html")
1616

1717

1818
@nox.session(name="docs-live")

0 commit comments

Comments
 (0)