Temporarily evade sphinx-doc/sphinxext-opengraph#87

Julian · Julian · commit 94e10d9a2569 · 2022-11-22T12:09:14.000-05:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,8 +33,7 @@
     "sphinx_copybutton",
     "sphinx_json_schema_spec",
     "sphinxcontrib.spelling",
-    # FIXME: Disabled, as it's raising exceptions on build. Needs looking into.
-    # "sphinxext.opengraph",
+    "sphinxext.opengraph",
 ]
 
 pygments_style = "lovelace"
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -146,7 +146,7 @@ sphinxcontrib-spelling==7.7.0
     # via -r docs/requirements.in
 sphinxext-opengraph==0.7.2
     # via -r docs/requirements.in
-structlog==22.1.0
+structlog==22.2.0
     # via bowtie-json-schema
 typing-extensions==4.4.0
     # via aiodocker
diff --git a/noxfile.py b/noxfile.py
@@ -113,6 +113,8 @@ def docs(session, builder):
         str(DOCS),
         str(tmpdir / builder),
         *argv,
+        # FIXME: https://github.com/wpilibsuite/sphinxext-opengraph/issues/87
+        env={} if builder != "dirhtml" else {"READTHEDOCS": "true"},
     )
 
 

Original file line number	Diff line number	Diff line change
`@@ -33,8 +33,7 @@`
`33`	`33`	`"sphinx_copybutton",`
`34`	`34`	`"sphinx_json_schema_spec",`
`35`	`35`	`"sphinxcontrib.spelling",`
`36`		`- # FIXME: Disabled, as it's raising exceptions on build. Needs looking into.`
`37`		`- # "sphinxext.opengraph",`
	`36`	`+ "sphinxext.opengraph",`
`38`	`37`	`]`
`39`	`38`
`40`	`39`	`pygments_style = "lovelace"`
Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,8 @@ def docs(session, builder):`
`113`	`113`	`str(DOCS),`
`114`	`114`	`str(tmpdir / builder),`
`115`	`115`	`*argv,`
	`116`	`+ # FIXME: https://github.com/wpilibsuite/sphinxext-opengraph/issues/87`
	`117`	`+ env={} if builder != "dirhtml" else {"READTHEDOCS": "true"},`
`116`	`118`	`)`
`117`	`119`
`118`	`120`