doc: add warning about handler threads which are left behind

csernazs · csernazs · commit 7016579872c7 · 2024-06-15T17:22:18.000+02:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -38,6 +38,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.autosectionlabel",
 ]
 
 intersphinx_mapping = {
diff --git a/doc/howto.rst b/doc/howto.rst
@@ -605,3 +605,10 @@ besides the main one.
 This will start and stop the server for each tests, which causes about 0.5
 seconds waiting when the server is stopped. It won't override the ``httpserver``
 fixture so you can keep the original single-threaded behavior.
+
+.. warning::
+    Handler threads which are still running when the test is finished, will be
+    left behind and won't be join()ed between the tests. If you want to ensure
+    that all threads are properly cleaned up and you want to wait for them,
+    consider using the second option (:ref:`Creating a different httpserver fixture`)
+    described above.

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@`
`38`	`38`	`extensions = [`
`39`	`39`	`"sphinx.ext.autodoc",`
`40`	`40`	`"sphinx.ext.intersphinx",`
	`41`	`+ "sphinx.ext.autosectionlabel",`
`41`	`42`	`]`
`42`	`43`
`43`	`44`	`intersphinx_mapping = {`