This repository has been archived by the owner on Dec 7, 2023. It is now read-only.
Add static openapi docs to sphinx site #28
Closed
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
|
Due to sphinx-contrib/openapi#107, it looks like sphinxcontrib.openapi does not correctly handle openapi 3.0.0 specs. We are having the same problem as that issue: the docs don't show request or response json parameters. |
This was referenced Jan 18, 2022
cisaacstern
approved these changes
Jan 18, 2022
| @@ -4,4 +4,6 @@ myst-parser==0.13.6 | |||
| myst-nb==0.12.3 | |||
| sphinx-copybutton==0.3.1 | |||
| sphinx-autodoc-typehints | |||
| sphinxcontrib-openapi | |||
| uvicorn | |||
There was a problem hiding this comment.
Out of curiosity, why does this require uvicorn?
There was a problem hiding this comment.
Good catch. Originally I thought you had to run the server, but I found a way to avoid that.
|
Following #9 (comment), going to close this, because it is superseded by #45. We can revisit it if we ever decide to go back to Sphinx. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
closes #9
The only thing I don't like about this is how the title shows up twice 🧐