[Git][reproducible-builds/reproducible-notes][master] issues.yml: add category for sphinx-autodoc evaluation where build environment is captured

[Holger Levsen (@holger)]

Holger Levsen pushed to branch master at Reproducible Builds / reproducible-notes


Commits:
6ac62ef7 by James Addison at 2024-02-24T15:27:42+01:00
issues.yml: add category for sphinx-autodoc evaluation where build environment is captured

Signed-off-by: Holger Levsen <holger at layer-acht.org>

- - - - -


1 changed file:

- issues.yml


Changes:

=====================================
issues.yml
=====================================
@@ -550,6 +550,14 @@ captures_build_path_in_sphinx_attr_links:
     Sphinx docs can contain hyperlinks to other parts of the doc, which include
     part of the build path.
   deterministic: True
+captures_environment_in_sphinx_autodoc:
+  description: |
+    The autodoc extension for Sphinx can dynamically evaluate function signatures,
+    and when default values for function parameters include environment context this
+    can cause reproducibility failures.
+    .
+    As a workaround, the autodoc_preserve_defaults setting can be enabled.
+      https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_preserve_defaults
 captures_build_path_via_cmake_variables:
   description: |
     Variables such as PROJECT_SOURCE_DIR or PROJECT_BINARY_DIR used in



View it on GitLab: https://salsa.debian.org/reproducible-builds/reproducible-notes/-/commit/6ac62ef700b316f29361245c59ca7824176c84a3

-- 
View it on GitLab: https://salsa.debian.org/reproducible-builds/reproducible-notes/-/commit/6ac62ef700b316f29361245c59ca7824176c84a3
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20240224/ade49ea2/attachment.htm>