Conversation
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.
Adds Sphinx-based API reference documentation infrastructure for the auth0-fastapi SDK. The generated JSON artifact is consumed by the auth0.com/docs Mintlify site to render the SDK reference at
/docs/sdk/python/fastapi.Changes made
Sphinx docs setup (
docs/)conf.py— Sphinx configuration usingsphinx-autoapi(AST-based, no import required),furotheme with Auth0 brand colors, Napoleon for Google-style docstrings, intersphinx mapping to Python and Pydantic docs. Includes aautoapi-skip-memberhook to suppress Pydantic internals (BaseModel.Config, auto-generated__init__docstrings) from the output.index.rst— Root document pointing to the autoapi-generated reference.Makefile— Build targets:html(local preview),json(Mintlify artifact),clean.requirements.txt— Pinned build dependencies:sphinx,sphinx-autoapi,furo._static/auth0.css— Auth0 brand colors and Pydantic-style parameter block styling for local HTML preview._templates/autoapi/python/module.rst— Custom page title template that uses the module's short name (e.g. "Auth Client") instead of the full dotted path.Source changes
src/auth0_fastapi/__init__.py— Added empty init to ensure autoapi resolves modules asauth0_fastapi.*rather thansrc.auth0_fastapi.*.src/auth0_fastapi/auth/auth_client.py— Improved docstrings for DX:TokenExchangeResponse,LoginWithCustomTokenExchangeResult,SessionTransferTokenResult) marked up with:class:for cross-linking.CustomTokenExchangeError,InvalidArgumentError,MissingRequiredArgumentError,ValueError) marked up with:exc:..gitignoredocsignore with targeted entries (docs/_build/,docs/reference/) so the Sphinx source files are tracked while build output is not.Generating the artifact