DM-37525: Add openapi generator extension #159
Merged
Conversation
This file contains 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
This Sphinx extension can run a user-provided function to generate the OpenAPI specification for, e.g., a FastAPI project.
- Include sphinxcontrib-redoc to the [guide] extras - In the default configuration for guides, include sphinxcontrib-redoc and documenteer.ext.openapi.
The new [project.openapi] section lets docs writers configure both documenteer.ext.openapi and sphinxcontrib-redoc to generate and include redoc docs in their site.
Add both the TOML reference for [project.openapi] and a guide for setting up the Redoc/OpenAPI site embed.
jonathansick
force-pushed
the
tickets/DM-37525
branch
from
569788e
to
9efb7c7
Compare
Setting the default to None makes the documenteer.toml use case easier so that the value can be set to None if the [project.openapi] table isn't set. Otherwise Sphinx raises a value that None is being set on a string-defaulted configuration.
jonathansick
force-pushed
the
tickets/DM-37525
branch
from
9efb7c7
to
c15d756
Compare
rra
approved these changes
Jun 7, 2023
There was a problem hiding this comment.
This looks great! Really happy with how easy this is to plug in to packages.
The demo with squarebot for some reason didn't work for me. I just see the stub page when I go to https://squarebot.lsst.io/v/DM-37525/api.html, I just see the stub page.
|
Whoops, looks like I broke it. I'll check this. |
|
https://squarebot.lsst.io/v/DM-37525/api.html is working again. I'm still not sure why the stub didn't get replaced; I haven't been able to replicate it. |
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.
This PR provides support for embedding a Redoc site for FastAPI apps and other projects that have OpenAPI specifications.
documenteer.ext.openapiSphinx extension can generate the OpenAPI specification during the Sphinx build by running a user-specified function. See the docs at https://documenteer.lsst.io/v/DM-37525/sphinx-extensions/openapi.htmldocumenteer.ext.openapiandsphinxcontrib.redocextensions are included by default with the Documenteer user guide configuration (documenteer[guide])[project.openapi]table in thedocumenteer.tomlconfiguration file. See the docs at https://documenteer.lsst.io/v/DM-37525/guides/openapi.htmlsphinxcontrib.redocextension. This solution removes the need to an API landing page.For a working demo see lsst-sqre/squarebot#18 and https://squarebot.lsst.io/v/DM-37525/index.html