Implement Sphinx autodoc for automatic documentation generation from docstrings #272
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.
Converts manual RST documentation to Sphinx autodoc to maintain docs in Python docstrings, enabling IDE integration and eliminating duplication between source code and website documentation.
Changes
Docstrings
presence.py,client.py,baseclient.py, andtypes.pySphinx Configuration
sphinx.ext.autodocandsphinx.ext.napoleonextensionssys.pathfor module importspresence.rstandclient.rstto use.. autoclass::directivesInfrastructure
.gitignoreto excludedocs/sphinx/_build/DEVELOPMENT.mdExample
Docstrings are now available in IDEs and auto-generated in documentation:
Build docs with:
cd docs/sphinx && sphinx-build -b html . _buildOriginal prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.