Users/kylerohn/sphinx docs - #533
Closed
Kyle Rohn (kylerohn-msft) wants to merge 4 commits into
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Sphinx-based documentation site (API reference + README inclusions) and a GitHub Pages workflow to build and publish docs for the Microsoft 365 Agents SDK for Python packages.
Changes:
- Introduces Sphinx docs skeleton (conf.py, index + per-package RST pages with autodoc and MyST includes).
- Adds documentation build tooling (Makefile/make.bat) and doc build dependencies.
- Adds a GitHub Actions workflow to build and deploy the docs to GitHub Pages on
release/*pushes.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/source/index.rst | New docs landing page with README include and package toctrees. |
| docs/source/conf.py | New Sphinx configuration for autodoc + MyST and RTD theme. |
| docs/Makefile | Sphinx make target wrapper for building docs on *nix. |
| docs/make.bat | Sphinx make wrapper for building docs on Windows. |
| dev_dependencies.txt | Adds Sphinx + MyST + RTD theme dependencies for doc builds. |
| .github/workflows/gh-pages.yml | CI workflow to build docs and deploy to GitHub Pages. |
| docs/source/microsoft_agents.activity.rst | Activity package page: README include + autodoc API reference. |
| docs/source/microsoft_agents.copilotstudio.client.rst | Copilot Studio client package page: README include + autodoc API reference. |
| docs/source/authentication/microsoft_agents.authentication.rst | Authentication package index page (toctree). |
| docs/source/authentication/microsoft_agents.authentication.msal.rst | MSAL auth package page: README include + autodoc API reference. |
| docs/source/authentication/microsoft_agents.authentication.entra_auth_sidecar.rst | Entra sidecar auth package page: README include + autodoc API reference. |
| docs/source/hosting/microsoft_agents.hosting.rst | Hosting package index page (toctree). |
| docs/source/hosting/microsoft_agents.hosting.core.rst | Hosting core package page: README include + autodoc API reference. |
| docs/source/hosting/microsoft_agents.hosting.aiohttp.rst | Aiohttp hosting package page: README include + autodoc API reference. |
| docs/source/hosting/microsoft_agents.hosting.fastapi.rst | FastAPI hosting package page: README include + autodoc API reference. |
| docs/source/hosting/microsoft_agents.hosting.dialogs.rst | Dialogs hosting package page: README include + autodoc API reference. |
| docs/source/hosting/microsoft_agents.hosting.msteams.rst | MSTeams hosting package page: README include + autodoc API reference. |
| docs/source/hosting/microsoft_agents.hosting.teams.rst | Teams hosting package page: README include + autodoc API reference. |
| docs/source/hosting/microsoft_agents.hosting.slack.rst | Slack hosting package page: README include + autodoc API reference. |
| docs/source/storage/microsoft_agents.storage.rst | Storage package index page (toctree). |
| docs/source/storage/microsoft_agents.storage.blob.rst | Blob storage package page: README include + autodoc API reference. |
| docs/source/storage/microsoft_agents.storage.cosmos.rst | Cosmos storage package page: README include + autodoc API reference. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+2
| microsoft_agents.activity | ||
| ================================== |
| @@ -0,0 +1,28 @@ | |||
| .. agents-for-js documentation master file, created by | |||
Comment on lines
+10
to
+13
| project = "Python Agents SDK" | ||
| copyright = "2026, Microsoft" | ||
| author = "Microsoft" | ||
| release = "v1.2.0" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.