Repository navigation
Conversation
Co-Authored-By: Claude <noreply@anthropic.com>
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
Adds a Sphinx setup that builds the SDK's API reference as JSON, plus the committed output the docs pipeline publishes to the Auth0 docs site. The SDK's runtime code and public API are unchanged.
Changes
sphinx/(conf.py,index.rst,Makefile,requirements.txt): sphinx-autoapi generates the reference fromsrc/withpoetry run make json.sphinx/json/: the 16 generated.fjsonpages (a root page and 15 module pages), read by the docs pipeline from the release tag.pyproject.tomlandpoetry.lock: a newdocsdependency group (sphinx,sphinx-autoapi)..gitignore: tracks only the.fjsonpages insphinx/json/and ignores the rest of Sphinx's output.The docs site shows a "Getting Started" page and a nested "API Reference" group. The link page autoapi generates and the package "Submodules" pages are left out through Sphinx settings (
autoapi_add_toctree_entry,exclude_patterns,autoapi_root). A new package needs anexclude_patternsentry.References
Needs a matching change in
docs-content-pipelineso top-level module folders are published.Testing
Checklist