Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace sphinx-redoc #732

Open
2 tasks
Tracked by #61
fmigneault opened this issue Oct 9, 2024 · 0 comments
Open
2 tasks
Tracked by #61

Replace sphinx-redoc #732

fmigneault opened this issue Oct 9, 2024 · 0 comments
Labels
ci/doc Issue related to documentation of the package feature/oas Issues related to OpenAPI specifications.

Comments

@fmigneault
Copy link
Collaborator

fmigneault commented Oct 9, 2024

Description

The API is currently documented by sphinxcontrib-redoc, but this plugin has not been maintained for years. The configuration options offered by native Redoc that would allow customizing the interface are not available because of this lack of maintenance.

Other plugins should be used.

Todo

@fmigneault fmigneault added ci/doc Issue related to documentation of the package feature/oas Issues related to OpenAPI specifications. labels Oct 9, 2024
@fmigneault fmigneault changed the title Replace sphinx-redoc by sphinx-openapi Replace sphinx-redoc Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/doc Issue related to documentation of the package feature/oas Issues related to OpenAPI specifications.
Projects
None yet
Development

No branches or pull requests

1 participant