support read the docs

AA-Turner · AA-Turner · commit af0756f258d1 · 2022-03-11T15:13:19.000Z
diff --git a/build.py b/build.py
@@ -81,6 +81,7 @@ def create_index_file(html_root: Path, builder: str) -> None:
         confoverrides=config_overrides,
         warningiserror=args.fail_on_warning,
         parallel=args.jobs,
+        tags=["internal_builder"],
     )
     app.build()
 
diff --git a/pep_sphinx_extensions/__init__.py b/pep_sphinx_extensions/__init__.py
@@ -22,11 +22,26 @@ def _depart_maths():
     pass  # No-op callable for the type checker
 
 
-def _update_config_for_builder(app: Sphinx):
+def _update_config_for_builder(app: Sphinx) -> None:
     app.env.document_ids = {}  # For PEPReferenceRoleTitleText
     if app.builder.name == "dirhtml":
         app.env.settings["pep_url"] = "../pep-{:0>4}"
 
+    # internal_builder exists if Sphinx is run by build.py
+    if "internal_builder" not in app.tags:
+        setattr(app.builder.templates.render, "_patched", True)  # don't modify the output
+        app.connect("build-finished", _post_build)  # Post-build tasks
+
+
+def _post_build(app: Sphinx, exception: Exception | None) -> None:
+    from pathlib import Path
+
+    from build import create_index_file
+
+    if exception is not None:
+        return
+    create_index_file(Path(app.outdir), app.builder.name)
+
 
 def setup(app: Sphinx) -> dict[str, bool]:
     """Initialize Sphinx extension."""
diff --git a/readthedocs.yaml b/readthedocs.yaml
@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+python:
+  install:
+    - requirements: requirements.txt
+
+sphinx:
+  builder: dirhtml
+
+search:
+  ignore: ['*']

Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,7 @@ def create_index_file(html_root: Path, builder: str) -> None:`
`81`	`81`	`confoverrides=config_overrides,`
`82`	`82`	`warningiserror=args.fail_on_warning,`
`83`	`83`	`parallel=args.jobs,`
	`84`	`+ tags=["internal_builder"],`
`84`	`85`	`)`
`85`	`86`	`app.build()`
`86`	`87`