Users/kylerohn/sphinx docs

.github/workflows/gh-pages.yml

@@ -0,0 +1,67 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Build and Deploy Docs
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: 
+      - 'release/*'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev_dependencies.txt
+          pip install ./libraries/microsoft-agents-activity/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-authentication-msal/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-authentication-entra-auth-sidecar/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-copilotstudio-client/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-hosting-aiohttp/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-hosting-core/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-hosting-teams/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-hosting-msteams/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-hosting-dialogs/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-hosting-fastapi/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-hosting-slack/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-storage-blob/ --config-settings editable_mode=compat
+          pip install ./libraries/microsoft-agents-storage-cosmos/ --config-settings editable_mode=compat
+      - name: Build Docs
+        run: |
+          cd docs
+          make html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './docs/build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

dev_dependencies.txt

@@ -3,4 +3,7 @@ pytest-asyncio
 pytest-aiohttp
 pytest-mock
 pre-commit
-click
+click
+sphinx
+myst-parser
+sphinx-rtd-theme

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/authentication/microsoft_agents.authentication.entra_auth_sidecar.rst

@@ -0,0 +1,14 @@
+microsoft\_agents.authentication.entra_auth_sidecar
+==========================================================
+
+.. include:: ../../../libraries/microsoft-agents-authentication-entra-auth-sidecar/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.authentication.entra_auth_sidecar
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/authentication/microsoft_agents.authentication.msal.rst

@@ -0,0 +1,14 @@
+microsoft_agents.authentication.msal
+============================================
+
+.. include:: ../../../libraries/microsoft-agents-authentication-msal/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.authentication.msal
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/authentication/microsoft_agents.authentication.rst

@@ -0,0 +1,9 @@
+microsoft\_agents.authentication
+========================================
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Packages:
+
+    microsoft_agents.authentication.msal
+    microsoft_agents.authentication.entra_auth_sidecar

docs/source/conf.py

@@ -0,0 +1,27 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Python Agents SDK"
+copyright = "2026, Microsoft"
+author = "Microsoft"
+release = "v1.2.0"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["sphinx.ext.autodoc", "myst_parser"]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]

docs/source/hosting/microsoft_agents.hosting.aiohttp.rst

@@ -0,0 +1,14 @@
+microsoft_agents.hosting.aiohttp
+========================================
+
+.. include:: ../../../libraries/microsoft-agents-hosting-aiohttp/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.hosting.aiohttp
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/hosting/microsoft_agents.hosting.core.rst

@@ -0,0 +1,14 @@
+microsoft_agents.hosting.core
+=====================================
+
+.. include:: ../../../libraries/microsoft-agents-hosting-core/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.hosting.core
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/hosting/microsoft_agents.hosting.dialogs.rst

@@ -0,0 +1,14 @@
+microsoft_agents.hosting.dialogs
+========================================
+
+.. include:: ../../../libraries/microsoft-agents-hosting-dialogs/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.hosting.dialogs
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/hosting/microsoft_agents.hosting.fastapi.rst

@@ -0,0 +1,14 @@
+microsoft_agents.hosting.fastapi
+========================================
+
+.. include:: ../../../libraries/microsoft-agents-hosting-fastapi/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.hosting.fastapi
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/hosting/microsoft_agents.hosting.msteams.rst

@@ -0,0 +1,14 @@
+microsoft_agents.hosting.msteams
+========================================
+
+.. include:: ../../../libraries/microsoft-agents-hosting-msteams/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.hosting.msteams
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/hosting/microsoft_agents.hosting.rst

@@ -0,0 +1,14 @@
+microsoft\_agents.hosting
+================================
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Packages:
+
+    microsoft_agents.hosting.core
+    microsoft_agents.hosting.aiohttp
+    microsoft_agents.hosting.dialogs
+    microsoft_agents.hosting.fastapi
+    microsoft_agents.hosting.msteams
+    microsoft_agents.hosting.teams
+    microsoft_agents.hosting.slack

docs/source/hosting/microsoft_agents.hosting.slack.rst

@@ -0,0 +1,14 @@
+microsoft_agents.hosting.slack
+======================================
+
+.. include:: ../../../libraries/microsoft-agents-hosting-slack/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.hosting.slack
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/hosting/microsoft_agents.hosting.teams.rst

@@ -0,0 +1,14 @@
+microsoft_agents.hosting.teams
+======================================
+
+.. include:: ../../../libraries/microsoft-agents-hosting-teams/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.hosting.teams
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/index.rst

@@ -0,0 +1,28 @@
+.. agents-for-js documentation master file, created by
+   sphinx-quickstart on Wed Jul 29 12:21:35 2026.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Python Agents SDK API Reference
+============================================
+
+.. include:: ../../README.md
+   :parser: myst_parser.sphinx_
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Packages:
+
+   microsoft_agents.activity
+
+.. toctree::
+   :maxdepth: 2
+
+   hosting/microsoft_agents.hosting
+   authentication/microsoft_agents.authentication
+   storage/microsoft_agents.storage
+
+.. toctree::
+   :maxdepth: 1
+
+   microsoft_agents.copilotstudio.client

docs/source/microsoft_agents.activity.rst

@@ -0,0 +1,14 @@
+microsoft_agents.activity
+==================================
+
+.. include:: ../../libraries/microsoft-agents-activity/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.activity
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members:

docs/source/microsoft_agents.copilotstudio.client.rst

@@ -0,0 +1,14 @@
+microsoft_agents.copilotstudio.client
+=============================================
+
+.. include:: ../../libraries/microsoft-agents-copilotstudio-client/readme.md
+   :parser: myst_parser.sphinx_
+
+API reference
+-------------
+
+.. automodule:: microsoft_agents.copilotstudio.client
+   :members:
+   :imported-members:
+   :show-inheritance:
+   :undoc-members: