Skip to content

docs: add Sphinx JSON reference for the docs site - #187

Open
rmad17 wants to merge 5 commits into
mainfrom
docs/sphinx-flat-reference
Open

rmad17 wants to merge 5 commits into
mainfrom
docs/sphinx-flat-reference

Conversation

@rmad17

@rmad17 rmad17 commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

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 from src/ with poetry run make json.
  • sphinx/json/: the 16 generated .fjson pages (a root page and 15 module pages), read by the docs pipeline from the release tag.
  • pyproject.toml and poetry.lock: a new docs dependency group (sphinx, sphinx-autoapi).
  • .gitignore: tracks only the .fjson pages in sphinx/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 an exclude_patterns entry.

References

Needs a matching change in docs-content-pipeline so top-level module folders are published.

Testing

poetry install --with docs
rm -rf sphinx/json
find sphinx -mindepth 1 -maxdepth 1 -type d ! -name json -exec rm -rf {} +
cd sphinx && poetry run make json
git status sphinx/json   # no changes expected
  • This change adds unit test coverage
  • This change adds integration test coverage
  • This change has been tested on the latest version of the platform/language or why not (local mint dev preview only)

Checklist

  • I have read the Auth0 general contribution guidelines
  • I have read the Auth0 Code of Conduct
  • All existing and new tests complete without errors

@rmad17
rmad17 requested a review from a team as a code owner November 6, 2026 08:24

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant