[DOC] Add doc on joblib + joblib_htcondor

docs/conf.py

@@ -212,39 +212,42 @@
 # -- Sphinx-Gallery configuration --------------------------------------------
 
 
-class SubSectionTitleOrder:
-    """Sort example gallery by title of subsection.
+# class SubSectionTitleOrder:
+#     """Sort example gallery by title of subsection.
 
-    Assumes README.txt exists for all subsections and uses the subsection with
-    dashes, '---', as the adornment.
-    """
+#     Assumes README.txt exists for all subsections and uses the subsection with
+#     dashes, '---', as the adornment.
+#     """
 
-    def __init__(self, src_dir):
-        self.src_dir = src_dir
-        self.regex = re.compile(r"^([\w ]+)\n-", re.MULTILINE)
+#     def __init__(self, src_dir):
+#         self.src_dir = src_dir
+#         self.regex = re.compile(r"^([\w ]+)\n-", re.MULTILINE)
 
-    def __repr__(self):
-        return f"<{self.__class__.__name__}>"
+#     def __reduce__(self):
+#         return (self.__class__, (self.src_dir, ))
 
-    def __call__(self, directory):
-        src_path = os.path.normpath(os.path.join(self.src_dir, directory))
+#     def __repr__(self):
+#         return f"<{self.__class__.__name__}>"
 
-        # Forces Release Highlights to the top
-        if os.path.basename(src_path) == "release_highlights":
-            return "0"
+#     def __call__(self, directory):
+#         src_path = os.path.normpath(os.path.join(self.src_dir, directory))
 
-        readme = os.path.join(src_path, "README.txt")
+#         # Forces Release Highlights to the top
+#         if os.path.basename(src_path) == "release_highlights":
+#             return "0"
 
-        try:
-            with open(readme) as f:
-                content = f.read()
-        except FileNotFoundError:
-            return directory
+#         readme = os.path.join(src_path, "README.txt")
 
-        title_match = self.regex.search(content)
-        if title_match is not None:
-            return title_match.group(1)
-        return directory
+#         try:
+#             with open(readme) as f:
+#                 content = f.read()
+#         except FileNotFoundError:
+#             return directory
+
+#         title_match = self.regex.search(content)
+#         if title_match is not None:
+#             return title_match.group(1)
+#         return directory
 
 
 ex_dirs = [
@@ -269,7 +272,7 @@ def __call__(self, directory):
     "examples_dirs": example_dirs,
     "gallery_dirs": gallery_dirs,
     "nested_sections": True,
-    "subsection_order": SubSectionTitleOrder("../examples"),
+    # "subsection_order": SubSectionTitleOrder("../examples"),
     "filename_pattern": "/(plot|run)_",
     "download_all_examples": False,
 }

docs/links.inc

@@ -43,3 +43,5 @@
 .. _`scikit-optimize`: https://scikit-optimize.readthedocs.io/en/stable/
 .. _`Optuna`: https://optuna.org
 .. _`optuna_integration`: https://github.com/optuna/optuna-integration
+.. _`Joblib`: https://joblib.readthedocs.io/en/stable/
+.. _`joblib-htcondor`: https://github.com/juaml/joblib-htcondor

docs/selected_deeper_topics/index.rst

@@ -16,3 +16,4 @@ Selected deeper topics
    cross_validation_splitter.rst
    stacked_models.rst
    CBPM.rst
+   joblib.rst