Finish debugging

docs/tutorial/en/build.sh

@@ -1,3 +1,9 @@
 #!/bin/bash
 
+set -e
+
+# Generate the API rst files
+sphinx-apidoc -o source/build_api ../../../src/agentscope -t source/_templates -e
+
+# Build the html
 sphinx-build -M html source build

docs/tutorial/en/source/_templates/module.rst_t

@@ -0,0 +1,5 @@
+{{ basename |  heading }}
+.. automodule:: {{ qualname }}
+{%- for option in automodule_options %}
+   :{{ option }}:
+{%- endfor %}

docs/tutorial/en/source/_templates/package.rst_t

@@ -0,0 +1,10 @@
+{%- macro automodule(modname, options) -%}
+.. automodule:: {{ modname }}
+{%- for option in options %}
+   :{{ option }}:
+{%- endfor %}
+{%- endmacro %}
+
+{{- pkgname | heading }}
+
+{{ automodule(pkgname, automodule_options) }}

docs/tutorial/en/source/conf.py

@@ -8,7 +8,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "AgentScope Doc"
-copyright = "2024, Alibaba"
+copyright = "2025, Alibaba"
 author = "Alibaba Tongyi Lab"
 
 # -- General configuration ---------------------------------------------------
@@ -17,6 +17,9 @@
 extensions = [
     "myst_parser",
     "sphinx_gallery.gen_gallery",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
 ]
 
 myst_enable_extensions = [
@@ -52,3 +55,23 @@
 ]
 
 source_suffix = [".md", ".rst"]
+
+
+# -- Options for API documentation -------------------------------------------
+
+autodoc_member_order = "groupwise"
+
+
+def skip_member(app, what, name, obj, skip, options):
+    if name in [
+        "Operator",
+        "ServiceFactory",
+        "",
+    ]:
+        return True
+
+    return skip
+
+
+def setup(app):
+    app.connect("autodoc-skip-member", skip_member)

docs/tutorial/en/source/index.rst

@@ -46,3 +46,19 @@ Welcome to AgentScope's documentation!
    :caption: Examples
 
    build_tutorial/examples
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API Docs
+
+   build_api/agentscope
+   build_api/agentscope.message
+   build_api/agentscope.models
+   build_api/agentscope.agents
+   build_api/agentscope.memory
+   build_api/agentscope.parsers
+   build_api/agentscope.rag
+   build_api/agentscope.service
+   build_api/agentscope.prompt
+   build_api/agentscope.tokens
+   build_api/agentscope.exception