search

factset / quart-openapi

Module for Quart to add Flask-RESTPlus like functionality
https://factset.github.io/quart-openapi/
Other
82 stars 22 forks source link

Update documentation #24

Closed mst-ableton closed 5 years ago

mst-ableton commented 5 years ago

Thanks for quart-openapi! I noticed that the documentation at https://factset.github.io/quart-openapi/ was missing for nearly all of the methods in pint.py. This PR addresses that in three ways:

  1. Using the correct class name for OpenApiView instead of the outdated SwaggerView.
  2. Explicitly specifying and rendering the 'hidden' methods in Pint and PintBlueprint due their importing BaseRest even though BaseRest is not imported in __init__.py (meaning it can't be directly autodoc'd by Sphinx).
  3. Un-recursiving one of the types in typing.py. Without this, Sphinx dies with a recursion error when trying to render response().

Let me know if you need anything done to make this PR fit your standards (or feel free to push up commits yourself if GitHub lets you). In particular, we may want to move from specifying members directly and using :inherited-members:, showing all the members of Quart in the process.

Thanks!

CLAassistant commented 5 years ago

CLA assistant check
All committers have signed the CLA.

zeroshade commented 5 years ago

Very cool, thanks for the contribution @mst-ableton!