Follow up changes from top bar change (#4758)

microsoft · Dec 19, 2024 · c74c2d6 · c74c2d6
1 parent 97e5cab
commit c74c2d6
Show file tree

Hide file tree

Showing 17 changed files with 199 additions and 143 deletions.
diff --git a/python/packages/autogen-core/docs/src/_static/custom.css b/python/packages/autogen-core/docs/src/_static/custom.css
@@ -73,4 +73,15 @@ html[data-theme="light"] .bd-header {
 .bd-content .sd-tab-set>label {
   background-color: transparent;
   border: none;
-}
+}
+
+.card-title {
+  font-size: 1.2rem;
+  font-weight: bold;
+}
+
+.card-title svg {
+  font-size: 2rem;
+  vertical-align: bottom;
+  margin-right: 5px;
+}
diff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-agentchat.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-agentchat.html
@@ -13,7 +13,26 @@
       )
     -}}
     <ul class="nav bd-sidenav">
-      <li class="toctree-l1"><a class="reference internal" href="{{pathto('reference/python/autogen_agentchat')}}">API Reference</a></li>
+      <li class="toctree-l1">
+        <a class="reference internal" href="{{pathto('reference/python/autogen_agentchat')}}">
+          <i class="fa-solid fa-file-code"></i>
+          API Reference
+        </a>
+      </li>
+      <li class="toctree-l1">
+        <a target="_blank" class="reference internal" href="https://pypi.org/project/autogen-agentchat/0.4.0.dev11/">
+          <i class="fa-brands fa-python"></i>
+          PyPi
+          <i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
+        </a>
+      </li>
+      <li class="toctree-l1">
+        <a target="_blank" class="reference internal" href="https://github.com/microsoft/autogen/tree/main/python/packages/autogen-agentchat">
+          <i class="fa-brands fa-github"></i>
+          Source
+          <i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
+        </a>
+      </li>
     </ul>
-    </div>
-</nav>
+  </div>
+</nav>
diff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-core.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-core.html
@@ -13,7 +13,26 @@
       )
     -}}
     <ul class="nav bd-sidenav">
-      <li class="toctree-l1"><a class="reference internal" href="{{pathto('reference/python/autogen_core')}}">API Reference</a></li>
+      <li class="toctree-l1">
+        <a class="reference internal" href="{{pathto('reference/python/autogen_core')}}">
+          <i class="fa-solid fa-file-code"></i>
+          API Reference
+        </a>
+      </li>
+      <li class="toctree-l1">
+        <a target="_blank" class="reference internal" href="https://pypi.org/project/autogen-core/0.4.0.dev11/">
+          <i class="fa-brands fa-python"></i>
+          PyPi
+          <i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
+        </a>
+      </li>
+      <li class="toctree-l1">
+        <a target="_blank" class="reference internal" href="https://github.com/microsoft/autogen/tree/main/python/packages/autogen-core">
+          <i class="fa-brands fa-github"></i>
+          Source
+          <i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
+        </a>
+      </li>
     </ul>
   </div>
 </nav>
diff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-extensions.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-extensions.html
@@ -14,7 +14,26 @@
     -}}
     <p aria-level="2" class="caption" role="heading"><span class="caption-text">More</span></p>
     <ul class="nav bd-sidenav">
-      <li class="toctree-l1"><a class="reference internal" href="{{pathto('reference/python/autogen_ext.agents.magentic_one')}}">API Reference</a></li>
+      <li class="toctree-l1">
+        <a class="reference internal" href="{{pathto('reference/python/autogen_ext.agents.magentic_one')}}">
+          <i class="fa-solid fa-file-code"></i>
+          API Reference
+        </a>
+      </li>
+      <li class="toctree-l1">
+        <a target="_blank" class="reference internal" href="https://pypi.org/project/autogen-ext/0.4.0.dev11/">
+          <i class="fa-brands fa-python"></i>
+          PyPi
+          <i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
+        </a>
+      </li>
+      <li class="toctree-l1">
+        <a target="_blank" class="reference internal" href="https://github.com/microsoft/autogen/tree/main/python/packages/autogen-ext">
+          <i class="fa-brands fa-github"></i>
+          Source
+          <i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
+        </a>
+      </li>
     </ul>
-    </div>
+  </div>
 </nav>
diff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-studio.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-studio.html
@@ -0,0 +1,32 @@
+{# Displays the TOC-subtree for pages nested under the currently active top-level TOCtree element. #}
+
+<nav class="bd-docs-nav bd-links"
+     aria-label="{{ _('Section Navigation') }}">
+  <div class="bd-toc-item navbar-nav">
+    {{- generate_toctree_html(
+      "sidebar",
+      show_nav_level=theme_show_nav_level | int,
+      maxdepth=theme_navigation_depth | int,
+      collapse=theme_collapse_navigation | tobool,
+      includehidden=theme_sidebar_includehidden | tobool,
+      titles_only=True
+      )
+    -}}
+    <ul class="nav bd-sidenav">
+      <li class="toctree-l1">
+        <a target="_blank" class="reference internal" href="https://pypi.org/project/autogenstudio/">
+          <i class="fa-brands fa-python"></i>
+          PyPi
+          <i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
+        </a>
+      </li>
+      <li class="toctree-l1">
+        <a target="_blank" class="reference internal" href="https://github.com/microsoft/autogen/tree/main/python/packages/autogen-studio">
+          <i class="fa-brands fa-github"></i>
+          Source
+          <i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
+        </a>
+      </li>
+    </ul>
+  </div>
+</nav>
diff --git a/python/packages/autogen-core/docs/src/conf.py b/python/packages/autogen-core/docs/src/conf.py
@@ -135,6 +135,7 @@
     "user-guide/core-user-guide/**": ["sidebar-nav-bs-core"],
     "user-guide/agentchat-user-guide/**": ["sidebar-nav-bs-agentchat"],
     "user-guide/extensions-user-guide/**": ["sidebar-nav-bs-extensions"],
+    "user-guide/autogenstudio-user-guide/**": ["sidebar-nav-bs-studio"],
 }
 
 html_context = {

diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.md
@@ -43,11 +43,13 @@ A framework for building AI agents and multi-agent applications
 
 <div style="margin-top: 2rem;">
 
-::::{grid} 1 1 2 2
+::::{grid}
+:gutter: 2
 
 :::{grid-item-card}
 :shadow: none
 :margin: 2 0 0 0
+:columns: 12 12 12 12
 
 <div class="sd-card-title sd-font-weight-bold docutils">
 
@@ -70,9 +72,29 @@ Get Started
 ```
 
 :::
+:::{grid-item-card} {fas}`palette;pst-color-primary` Studio
+:shadow: none
+:margin: 2 0 0 0
+:columns: 12 12 12 12
+
+No-code platform for authoring and interacting with multi-agent teams.
+
++++
+
+```{button-ref} user-guide/autogenstudio-user-guide/index
+:color: secondary
+
+Get Started
+```
+
+:::
+
+
 :::{grid-item-card} {fas}`cube;pst-color-primary` Core
 :shadow: none
 :margin: 2 0 0 0
+:columns: 12 12 6 6
+
 
 Provides building blocks for creating asynchronous, event driven multi-agent systems.
 
@@ -89,6 +111,29 @@ Get Started
 ```
 
 :::
+
+:::{grid-item-card} {fas}`puzzle-piece;pst-color-primary` Extensions
+:shadow: none
+:margin: 2 0 0 0
+:columns: 12 12 6 6
+
+
+Implementations of core components that interface with external services, or use extra dependencies. For example, Docker based code execution.
+
+```sh
+pip install 'autogen-ext==0.4.0.dev11'
+```
+
++++
+
+```{button-ref} user-guide/extensions-user-guide/index
+:color: secondary
+
+Get Started
+```
+
+:::
+
 ::::
 
 </div>
@@ -98,9 +143,8 @@ Get Started
 :hidden:
 
 user-guide/agentchat-user-guide/index
-Studio <user-guide/autogenstudio-user-guide/index>
 user-guide/core-user-guide/index
 user-guide/extensions-user-guide/index
-packages/index
+Studio <user-guide/autogenstudio-user-guide/index>
 reference/index
 ```
diff --git a/python/packages/autogen-core/docs/src/packages/index.md b/python/packages/autogen-core/docs/src/packages/index.md
diff --git a/python/packages/autogen-core/docs/src/reference/python/autogen_core.tools.rst b/python/packages/autogen-core/docs/src/reference/python/autogen_core.tools.rst
@@ -1,5 +1,5 @@
 autogen\_core.tools
-==============================
+===================
 
 
 .. automodule:: autogen_core.tools

diff --git a/...packages/autogen-core/docs/src/reference/python/autogen_ext.tools.langchain.rst b/...packages/autogen-core/docs/src/reference/python/autogen_ext.tools.langchain.rst
@@ -1,8 +1,8 @@
-autogen\_ext.tools
-==================
+autogen\_ext.tools.langchain
+============================
 
 
-.. automodule:: autogen_ext.tools
+.. automodule:: autogen_ext.tools.langchain
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md
@@ -16,7 +16,6 @@ programming model provides more flexibility and control over the underlying comp
 AgentChat provides intuitive defaults, such as **Agents** with preset
 behaviors and **Teams** with predefined [multi-agent design patterns](../core-user-guide/design-patterns/intro.md).
 
-
 ::::{grid} 2 2 2 2
 :gutter: 3