Allow sphinx-autobuild time to shutdown http server in tox

rmartin16 · rmartin16 · commit 794cf09e33dc · 2024-06-13T17:54:33.000-04:00
- Tox is apparently a bit aggressive in shutting down processes when it
  receives a CTRL+C; this can ultimately result in tox exiting and
  leaving the HTTP server still running requiring manual process kills.
- I think this results from ``sphinx-autobuild`` receiving the SIGINT
  and starting its shutdown...but tox then sends it _another_ SIGINT
  that seems to abort the shutdown procedure for ``sphinx-autobuild``.
- So, this gives ``sphinx-autobuild`` a window of time to shutdown
  before tox starts trying to help.
diff --git a/changes/xxx.misc.rst b/changes/xxx.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.