Skip to content

Commit b79606b

Browse files
authored
Merge pull request #5375 from rtfd/gsoc-swagger
Add a GSOC section for openAPI
2 parents a98aac4 + 985ca37 commit b79606b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/gsoc.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,19 @@ we would allow them to do a few sets of actions on them:
8181

8282
There is likely other ideas that could be done with `Collections` over time.
8383

84+
Integration with OpenAPI/Swagger
85+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86+
87+
Integrate the existing tooling around OpenAPI & Swagger into Sphinx and Read the Docs.
88+
This will include building some extensions that generate reStructuredText,
89+
and backend Django code that powers the frontend Javascript.
90+
91+
This could include:
92+
93+
* Building a live preview for testing an API in the documentation
94+
* Taking a swagger YAML file and generating HTML properly with Sphinx
95+
* Integration with our existing API to generate Swagger output
96+
8497
Autobuild docs for Pull Requests
8598
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8699

0 commit comments

Comments
 (0)