Skip to content

auto documentation #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TahaBinhuraib wants to merge 2 commits into
base: main
Choose a base branch
from
Open

auto documentation #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02a159d
auto documentation
TahaBinhuraib Sep 26, 2025
48caec1
update gitignore
TahaBinhuraib Sep 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ audio_files/
# anything that has cache
*cache*/
*Cache*/

_autosummary/
tutorial_scripts/
sdist/
var/
wheels/
Expand Down
18 changes: 3 additions & 15 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
"datasets",
"nltk",
"scikit-learn",
"sklearn",
"statsmodels",
"shap",
"numba",
Expand Down Expand Up @@ -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",
Expand All @@ -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
Expand Down