Update conf.py (#92)

LouisCarpentier42 · web-flow · commit ec07e0ed499b · 2025-02-17T17:19:36.000+01:00
* Update conf.py

Signed-off-by: LouisCarpentier42 &lt;louis.carpentier@kuleuven.be&gt;

* Update changelog.rst

Signed-off-by: LouisCarpentier42 &lt;louis.carpentier@kuleuven.be&gt;

---------

Signed-off-by: LouisCarpentier42 &lt;louis.carpentier@kuleuven.be&gt;
diff --git a/docs/additional_information/changelog.rst b/docs/additional_information/changelog.rst
@@ -16,6 +16,10 @@ Changed
 Fixed
 ^^^^^
 - Fixed typo in error-message for computing window size for multivariate time series.
+- Fixed issue when generating the documentation through read the docs. The module
+  'pyximport' within tslearn was not found, while this is not necessary for our
+  codebase. Therefore, we have addid this dependency to the mock imports, which fixed
+  the issue.
 
 [0.3.0] - 2025-01-31
 --------------------
diff --git a/docs/conf.py b/docs/conf.py
@@ -79,3 +79,6 @@
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'dtaianomalydoc'
+
+# Prevent issue with pyximport when generating docs through readthedocs
+autodoc_mock_imports = ["pyximport"]
