1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
Description: improve Sphinx documentation reproducibility by preserving argument defaults
The TaskVineManagerConfig dataclass includes an 'address' attribute that
is set to the value of socket.gethostname() when the class is loaded.
.
Meanwhile, the TaskVineExecutor.__init__ method 'manager_config' argument
has a default value of a no-args constructed TaskVineManagerConfig instance.
.
When Sphinx builds documentation, by default it will emit a Python repr() of
the manager_config argument, causing the hostname of the build host to be
included.
.
We can solve that by instructing the Sphinx autodoc extension to retain the
textual representation of argument lists as they are found in the source
code, instead of evaluated and repr'd equivalents.
Author: James Addison <jay@jp-hosting.net>
Bug-Debian: https://bugs.debian.org/1063542
Forwarded: https://github.com/Parsl/parsl/pull/3225
Reviewed-By: Étienne Mollier <emollier@debian.org>
---
--- python-parsl.orig/docs/conf.py
+++ python-parsl/docs/conf.py
@@ -366,3 +366,4 @@
'members': True,
'undoc-members': True
}
+autodoc_preserve_defaults = True
|
