Skip to content

Replace Sphinx Redoc with Swagger API Docs#67390

Draft
jscheffl wants to merge 1 commit into
apache:mainfrom
jscheffl:feature/replace-redoc-with-swagger
Draft

Replace Sphinx Redoc with Swagger API Docs#67390
jscheffl wants to merge 1 commit into
apache:mainfrom
jscheffl:feature/replace-redoc-with-swagger

Conversation

@jscheffl
Copy link
Copy Markdown
Contributor

@jscheffl jscheffl commented May 23, 2026

As we have the Sphinx-Redoc issue with setuptools still not fixed and it seems the plugin is not maintained (see sphinx-contrib/redoc#54) this PR attempts to replace it with swagger. As this is better maintained.

DRAFT because:

What is does:

  • Remove redoc, allows to bump setuptools again!
  • Add swagger redenring from another lib (see https://pypi.org/project/swagger-plugin-for-sphinx/)
  • Adjust to mirror swagger code into the doctree for privacy
  • Adjust core, simple-auth-manager, fab and keycloak to new doc rendering
  • Add Edge REST API generation

New look:

image
Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant