Merge pull request #2647 from rmartin16/docs-live-shutdown

freakboy3742 · web-flow · commit ad6635d8c5cb · 2024-06-14T07:07:45.000+08:00
Allow ``sphinx-autobuild`` time to shutdown http server in tox
diff --git a/changes/2647.misc.rst b/changes/2647.misc.rst
@@ -0,0 +1 @@
+The "live docs" tox environments were updated to allow a grace period for ``sphinx-autobuild`` to shutdown the HTTP server. Without waiting, the HTTP server may have been left running when tox exited.
diff --git a/tox.ini b/tox.ini
@@ -93,6 +93,8 @@ sphinx_args = -T -W --keep-going --jobs auto
 
 [testenv:docs{,-lint,-all,-live,-live-src}]
 skip_install = True
+# give sphinx-autobuild time to shutdown http server
+suicide_timeout = 1
 deps =
     # editable install so docstrings can be updated for 'all' and 'live'
     -e {tox_root}{/}core[docs]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+The "live docs" tox environments were updated to allow a grace period for ``sphinx-autobuild`` to shutdown the HTTP server. Without waiting, the HTTP server may have been left running when tox exited.