API documentation page flattening (#4556)

* API documentation page refactor * Fix links and unused pages --------- Co-authored-by: Jack Gerrits <jack@jackgerrits.com>
2026-02-11 20:14:59 -05:00 · 2024-12-04 18:24:07 -08:00
parent e615059345
commit cc6765b189
31 changed files with 247 additions and 48 deletions
--- a/python/packages/autogen-core/docs/src/packages/index.md
+++ b/python/packages/autogen-core/docs/src/packages/index.md
@@ -34,7 +34,7 @@ Library that is at a similar level of abstraction as AutoGen 0.2, including defa
 pip install 'autogen-agentchat==0.4.0.dev8'
 ```

-[{fas}`circle-info;pst-color-primary` User Guide](/user-guide/agentchat-user-guide/index.md) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_agentchat/autogen_agentchat.rst) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-agentchat/0.4.0.dev8/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-agentchat)
+[{fas}`circle-info;pst-color-primary` User Guide](/user-guide/agentchat-user-guide/index.md) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_agentchat.rst) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-agentchat/0.4.0.dev8/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-agentchat)
 :::

 (pkg-info-autogen-core)=
@@ -49,7 +49,7 @@ Implements the core functionality of the AutoGen framework, providing basic buil
 pip install 'autogen-core==0.4.0.dev8'
 ```

-[{fas}`circle-info;pst-color-primary` User Guide](/user-guide/core-user-guide/index.md) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_core/autogen_core.rst) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-core/0.4.0.dev8/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-core)
+[{fas}`circle-info;pst-color-primary` User Guide](/user-guide/core-user-guide/index.md) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_core.rst) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-core/0.4.0.dev8/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-core)
 :::

 (pkg-info-autogen-ext)=
@@ -71,7 +71,7 @@ Extras:
 - `docker` needed for {py:class}`~autogen_ext.code_executors.DockerCommandLineCodeExecutor`
 - `openai` needed for {py:class}`~autogen_ext.models.OpenAIChatCompletionClient`

-[{fas}`circle-info;pst-color-primary` User Guide](/user-guide/extensions-user-guide/index.md) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_ext/autogen_ext.rst) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-ext/0.4.0.dev8/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-ext)
+[{fas}`circle-info;pst-color-primary` User Guide](/user-guide/extensions-user-guide/index.md) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_ext.agents.web_surfer.rst) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-ext/0.4.0.dev8/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-ext)
 :::

 (pkg-info-autogen-magentic-one)=
--- a/python/packages/autogen-core/docs/src/reference/index.md
+++ b/python/packages/autogen-core/docs/src/reference/index.md
@@ -11,24 +11,44 @@ myst:
 :hidden:
 :caption: AutoGen AgentChat

-python/autogen_agentchat/autogen_agentchat
+python/autogen_agentchat
+python/autogen_agentchat.messages
+python/autogen_agentchat.agents
+python/autogen_agentchat.teams
+python/autogen_agentchat.base
+python/autogen_agentchat.conditions
+python/autogen_agentchat.ui
+python/autogen_agentchat.state
 ```

 ```{toctree}
 :hidden:
 :caption: AutoGen Core

-python/autogen_core/autogen_core
+python/autogen_core
+python/autogen_core.components.models
+python/autogen_core.components.code_executor
+python/autogen_core.components.model_context
+python/autogen_core.components.tools
+python/autogen_core.components.tool_agent
+python/autogen_core.exceptions
+python/autogen_core.logging
 ```

 ```{toctree}
 :hidden:
 :caption: AutoGen Extensions

-python/autogen_ext/autogen_ext
+python/autogen_ext.agents.web_surfer
+python/autogen_ext.agents.file_surfer
+python/autogen_ext.agents.video_surfer
+python/autogen_ext.agents.video_surfer.tools
+python/autogen_ext.models
+python/autogen_ext.tools
+python/autogen_ext.runtimes.grpc
 ```

-::::{grid} 1 2 2 3
+<!-- ::::{grid} 1 2 2 3
 :margin: 4 4 0 0
 :gutter: 1

@@ -50,5 +70,4 @@ python/autogen_ext/autogen_ext
 :class-item: api-card
 :::

-::::
-
+:::: -->
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.agents.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.agents.rst
@@ -0,0 +1,8 @@
+autogen\_agentchat.agents
+=========================
+
+
+.. automodule:: autogen_agentchat.agents
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.base.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.base.rst
@@ -0,0 +1,8 @@
+autogen\_agentchat.base
+=======================
+
+
+.. automodule:: autogen_agentchat.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.conditions.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.conditions.rst
@@ -0,0 +1,8 @@
+autogen\_agentchat.conditions
+=============================
+
+
+.. automodule:: autogen_agentchat.conditions
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.messages.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.messages.rst
@@ -0,0 +1,7 @@
+autogen\_agentchat.messages
+===========================
+
+.. automodule:: autogen_agentchat.messages
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.rst
@@ -0,0 +1,7 @@
+autogen\_agentchat
+==================
+
+.. automodule:: autogen_agentchat
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.state.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.state.rst
@@ -0,0 +1,8 @@
+autogen\_agentchat.state
+========================
+
+
+.. automodule:: autogen_agentchat.state
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.teams.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.teams.rst
@@ -0,0 +1,8 @@
+autogen\_agentchat.teams
+========================
+
+
+.. automodule:: autogen_agentchat.teams
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.ui.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_agentchat.ui.rst
@@ -0,0 +1,8 @@
+autogen\_agentchat.ui
+=====================
+
+
+.. automodule:: autogen_agentchat.ui
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.code_executor.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.code_executor.rst
@@ -0,0 +1,8 @@
+autogen\_core.components.code\_executor
+=======================================
+
+
+.. automodule:: autogen_core.components.code_executor
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.model_context.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.model_context.rst
@@ -0,0 +1,8 @@
+autogen\_core.components.model\_context
+=======================================
+
+
+.. automodule:: autogen_core.components.model_context
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.models.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.models.rst
@@ -0,0 +1,8 @@
+autogen\_core.components.models
+===============================
+
+
+.. automodule:: autogen_core.components.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.tool_agent.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.tool_agent.rst
@@ -0,0 +1,8 @@
+autogen\_core.components.tool\_agent
+====================================
+
+
+.. automodule:: autogen_core.components.tool_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.tools.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_core.components.tools.rst
@@ -0,0 +1,8 @@
+autogen\_core.components.tools
+==============================
+
+
+.. automodule:: autogen_core.components.tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_core.exceptions.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_core.exceptions.rst
@@ -0,0 +1,7 @@
+autogen\_core.exceptions
+========================
+
+.. automodule:: autogen_core.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_core.logging.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_core.logging.rst
@@ -0,0 +1,7 @@
+autogen\_core.logging
+=====================
+
+.. automodule:: autogen_core.logging
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_core.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_core.rst
@@ -0,0 +1,8 @@
+autogen\_core
+=============
+
+
+.. automodule:: autogen_core
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.agents.file_surfer.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.agents.file_surfer.rst
@@ -0,0 +1,8 @@
+autogen\_ext.agents.file\_surfer
+================================
+
+
+.. automodule:: autogen_ext.agents.file_surfer
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.agents.video_surfer.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.agents.video_surfer.rst
@@ -0,0 +1,7 @@
+autogen\_ext.agents.video\_surfer
+=================================
+
+.. automodule:: autogen_ext.agents.video_surfer
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.agents.video_surfer.tools.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.agents.video_surfer.tools.rst
@@ -0,0 +1,7 @@
+autogen\_ext.agents.video\_surfer.tools
+=======================================
+
+.. automodule:: autogen_ext.agents.video_surfer.tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.agents.web_surfer.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.agents.web_surfer.rst
@@ -0,0 +1,8 @@
+autogen\_ext.agents.web\_surfer
+===============================
+
+
+.. automodule:: autogen_ext.agents.web_surfer
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.models.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.models.rst
@@ -0,0 +1,8 @@
+autogen\_ext.models
+===================
+
+
+.. automodule:: autogen_ext.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.runtimes.grpc.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.runtimes.grpc.rst
@@ -0,0 +1,7 @@
+autogen\_ext.runtimes.grpc
+==========================
+
+.. automodule:: autogen_ext.runtimes.grpc
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.tools.rst
+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.tools.rst
@@ -0,0 +1,8 @@
+autogen\_ext.tools
+==================
+
+
+.. automodule:: autogen_ext.tools
+   :members:
+   :undoc-members:
+   :show-inheritance: