Repository navigation
Conversation
rmad17
marked this pull request as ready for review
October 6, 2026 05:54
…/mintlify-poc-server-python
| author = "Auth0" | ||
| copyright = "2024, Auth0" | ||
| with open(os.path.join(os.path.abspath(".."), ".version")) as _version_file: | ||
| release = _version_file.read().strip() |
This branch has not been deployed
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.
Summary
This PR adds a Sphinx setup to the SDK repo. One command builds a browsable API reference from the docstrings we already have, and a second builds the Sphinx JSON that Mintlify's Sphinx converter reads.
Nothing in the SDK itself changes: no source code and no public API.
How it works
sphinx-autoapireadssrc/and writes a reference page for every module. It parses the code as text, so the SDK is not imported.sphinx.ext.napoleonunderstands our Google-style docstrings.make htmlbuilds a normal Sphinx site with the default theme. AutoAPI's own table of contents gives a nested sidebar, with the packages as folders and the modules inside them.make jsonbuilds Sphinx's JSON output (.fjson), which Mintlify'ssphinxSDK format can read.Additions to Sphinx Config
_templates/autoapi/python/module.rst).[source]links to the definition on GitHub (sphinx.ext.linkcode, about 34 lines inconf.py).intersphinxlinks built-ins to the Python docs, and a smallmissing-referencehandler (about 20 lines inconf.py) mapsauth0_server_python.x.Yannotations to AutoAPI'sx.Ypages.add_module_names = False), skipping PydanticConfigclasses, and reading the version from.version.Changes
sphinx/conf.pysphinx/_templates/autoapi/python/module.rstsphinx/index.rst,sphinx/Makefilesphinx/requirements.txt,pyproject.toml,poetry.lockdocsdependency group withsphinxandsphinx-autoapionly.gitignoresphinx/_buildandsphinx/referenceRunning it
Add
O=-Eto either command to make Sphinx re-read every file. The output folders are not committed.Testing
No SDK source changed, so there are no new unit tests.
poetry run pytestpasses (877 tests) andruff check .is clean.