From 02a159dc5abb7e0d77d8b4270d3bb9e50e91786d Mon Sep 17 00:00:00 2001 From: TahaBinhuraib Date: Fri, 26 Sep 2025 15:43:07 -0400 Subject: [PATCH 1/2] auto documentation --- docs/conf.py | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 90e96b7..e091e11 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,6 +47,7 @@ "datasets", "nltk", "scikit-learn", + "sklearn", "statsmodels", "shap", "numba", @@ -77,7 +78,7 @@ napoleon_use_param = True napoleon_use_rtype = True -# Autodoc settings +# Enable autodoc to generate API documentation autodoc_default_options = { "members": True, "member-order": "bysource", @@ -86,22 +87,9 @@ "exclude-members": "__weakref__", } -# Autosummary settings +# Enable autosummary to automatically generate module documentation autosummary_generate = True -# Skip problematic modules during autosummary generation -autosummary_imported_members = False -autosummary_mock_imports = [ - "encoding.models", - "encoding.features", - "encoding.assembly", - "encoding.plotting", - "encoding.brain_projection", - "encoding.downsample", - "encoding.utils", - "encoding.trainer", -] - # HTML output options try: import sphinx_rtd_theme # noqa: F401 From 48caec10b12432aee8d702a24e093f2f302fff24 Mon Sep 17 00:00:00 2001 From: TahaBinhuraib Date: Sat, 27 Sep 2025 20:45:14 -0400 Subject: [PATCH 2/2] update gitignore --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 564feee..91a97ab 100644 --- a/.gitignore +++ b/.gitignore @@ -28,7 +28,8 @@ audio_files/ # anything that has cache *cache*/ *Cache*/ - +_autosummary/ +tutorial_scripts/ sdist/ var/ wheels/