bocadilloproject / bocadillo

(UNMAINTAINED) Fast, scalable and real-time capable web APIs for everyone
https://bocadilloproject.github.io
MIT License
396 stars 41 forks source link

Add API reference for the API class #26

Closed florimondmanca closed 5 years ago

florimondmanca commented 5 years ago

Is your feature request related to a problem? Please describe. Pydoc-Markdown has been added to the repo, we can now start writing API reference documentation, so let's start with the API class.

Describe the solution you'd like Refactor the API class' docstrings to be Pydoc-Markdown-friendly, then generate the docs and add a new child to the API Reference section.

florimondmanca commented 5 years ago

It's live! https://bocadilloproject.github.io/api/api.html