Merge pull request #15 from MatthewSZhang/doc-init

DOC add class and function template
scikit-learn-contrib · Oct 22, 2024 · f09b191 · f09b191
2 parents 589fa3e + 5b5c845
commit f09b191
Show file tree

Hide file tree

Showing 5 changed files with 723 additions and 665 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -48,7 +48,11 @@
 # directories to ignore when looking for source files.
 exclude_patterns = ["_build"]
 
-autodoc_default_options = {"members": True, "inherited-members": True}
+# Hide class prefix in right sidebar.
+toc_object_entries_show_parents = "hide"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["templates"]
 
 # generate autosummary even if no references
 autosummary_generate = True

diff --git a/doc/templates/autosummary/class.rst b/doc/templates/autosummary/class.rst
@@ -0,0 +1,8 @@
+{{ objname | escape | underline(line="=") }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :inherited-members:
+   :special-members: __call__
diff --git a/doc/templates/autosummary/function.rst b/doc/templates/autosummary/function.rst
@@ -0,0 +1,5 @@
+{{ objname | escape | underline(line="=") }}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ objname }}