Repository navigation
docs: Added basic sphinx generation setup - #150
Merged
Merged
Conversation
Co-Authored-By: Claude <noreply@anthropic.com>
cschetan77
previously approved these changes
Nov 5, 2026
cschetan77
previously approved these changes
Nov 12, 2026
Piyush-85
approved these changes
Nov 13, 2026
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.
Changes
Adds an optional Sphinx build that generates the SDK's API reference from its docstrings as JSON. It uses
sphinx-autoapiandnapoleonwith Sphinx's default theme, with no custom extensions, templates or hooks. The generated pages are committed undersphinx/json/. The PR adds no runtime behavior and changes no SDK code.sphinx/conf.py,sphinx/index.rst: AutoAPI config withautoapi_root = ".", so pages are written tosphinx/json/auth0_api_python/<module>/index.fjson.releaseis read from.version. The package pageauth0_api_python/index.rstis excluded, because it only lists the submodules and repeats the package docstring.autoapi_optionsomitsimported-members, so re-exports aren't documented twice.index.rsthas a hidden glob toctree.sphinx/Makefile:help,html,jsonandcleantargets. Paths are anchored to the Makefile's location, so it works from any directory.make -f sphinx/Makefile jsonis equivalent to thesphinx-build -b jsoncommand below.pyproject.toml,poetry.lock: new optional Poetrydocsgroup withsphinx8.1.3 andsphinx-autoapi(>=3.4,<4), bothpython >=3.10. The group is optional, sopoetry installand the existing CI test workflow are unchanged..gitignore: ignoressphinx/_build/, the module sources AutoAPI writes next toconf.py(sphinx/*/), and the non-page files Sphinx writes intosphinx/json/(_sources,_static,searchindex.json,genindex.fjsonand so on). Only the page JSON is tracked.sphinx/json/: 12 generated.fjsonfiles, 11 module pages and the rootindex.fjson. Nothing regenerates them automatically, so they must be rebuilt and committed when the public API or docstrings change.Build commands:
Testing
No unit or integration tests apply, because the PR adds no runtime code. To check the output, run the build commands above and confirm
git status sphinx/jsonshows no changes. The generated JSON has not been tested against a documentation site.Checklist