Repository navigation
Conversation
|
|
||
| project = "auth0-api-python" | ||
| with open(os.path.join(os.path.abspath(".."), ".version")) as _version_file: | ||
| release = _version_file.read().strip() |
Co-Authored-By: Claude <noreply@anthropic.com>
cschetan77
approved these changes
Nov 5, 2026
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 an optional Sphinx build that generates the SDK's API reference from its docstrings, so Mintlify can publish it. The build uses
sphinx-autoapiandnapoleonwith Sphinx's default theme and no custom extensions or templates. It outputs one JSON page per public module, and the committed copy insphinx/json/is what Mintlify consumes. The docs dependencies live in an optional Poetry group, so installing and testing the SDK works as before. The PR adds no runtime behavior and changes no SDK code.Changes
sphinx/conf.py,sphinx/index.rst: minimal Sphinx config usingsphinx-autoapito generate one page per module under atoctree, withnapoleonfor the docstrings.autoapi_optionsomitsimported-membersso the package's re-exports aren't documented twice.releaseis read from.version.sphinx/Makefile:help,html,jsonandcleantargets.make -C sphinx jsonis equivalent to thesphinx-build -b jsoncommand below and writes tosphinx/json.pyproject.toml,poetry.lock: new optional Poetrydocsgroup withsphinx8.1.3 andsphinx-autoapi(>=3.4,<4), allpython >=3.10. The group is optional, sopoetry installand the existing CI test workflow are unchanged..gitignore: ignoressphinx/_build/(build output) andsphinx/autoapi/(intermediate files sphinx-autoapi writes during a build). It also ignores everything insphinx/json/exceptautoapi/andindex.fjson, so only the page JSON is committed and the rest of the Sphinx output (_sources,_static,searchindex.json,objects.invand so on) stays untracked.sphinx/json/: 14 generated.fjsonfiles (about 316 KB), built withsphinx-build -b jsondirectly into this directory. They are committed so Mintlify can consume them without a build step. Nothing regenerates them yet, so they will go stale after the next API change.Build commands: