Skip to content

Commit fe149d2

Browse files
committed
fixing docs
1 parent 964fba0 commit fe149d2

4 files changed

Lines changed: 11 additions & 12 deletions

File tree

-2 Bytes
Binary file not shown.
-948 Bytes
Binary file not shown.
-2 Bytes
Binary file not shown.

docs/source/api/src.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,27 @@ This package provides core functionalities for extracting, organizing, and visua
1515
Public API Members
1616
------------------
1717

18-
.. autosummary::
19-
:toctree: _autosummary/src
20-
:template: autosummary/module_short.rst
21-
:nosignatures:
22-
23-
src
24-
25-
# If you have specific top-level classes or functions you know are directly
26-
# under 'src' (e.g., in src/__init__.py), you can add them here:
18+
# REMOVE the 'src' line from here. We'll use this autosummary block
19+
# when you have specific classes/functions/submodules to list.
20+
# For now, 'automodule' will handle the full documentation.
21+
# If you want to add specific top-level classes/functions later:
2722

2823
# .. autosummary::
29-
# :toctree: _autosummary/src # <--- REMOVE the comment here if you uncomment this block!
24+
# :toctree: _autosummary/src
3025
# :template: autosummary/class.rst
3126
# :nosignatures:
3227
#
3328
# src.YourTopLevelClass
3429
# src.AnotherClass
3530

3631
# .. autosummary::
37-
# :toctree: _autosummary/src # <--- REMOVE the comment here if you uncomment this block!
32+
# :toctree: _autosummary/src
3833
# :template: autosummary/function.rst
3934
# :nosignatures:
4035
#
4136
# src.your_top_level_function
42-
# src.another_function
37+
# src.another_function
38+
39+
# Sub-modules and more detailed content will go here once you are ready
40+
# to document them, similar to what we discussed previously.
41+
# For now, the 'automodule' above will list them implicitly if they are public members.

0 commit comments

Comments
 (0)