PR#17: Create a docs project and add documentation for all the HTTP endpoints in the API -

waiverdb

#17 Create a docs project and add documentation for all the HTTP endpoints in the API

Merged Mar 25, 2017 by ralph. Opened Mar 16, 2017 by jcline.

jcline/waiverdb add-docs into master

jcline commented Mar 16, 2017

I wanted to get a lay of the land and see what the API was like, so I figured it would be helpful to document it along the way. This adds a Sphinx project and the API documentation is automatically generated with the httpdomain extension. Since none of the API endpoints had documentation, I wrote that as well.

This also adds a tox test environment that builds the docs with warnings treated as errors so malformed RST can't slip in.

2 new commits added

Add documentation for all the HTTP endpoints in the API
Start a Sphinx docs project

Mar 16, 2017

mjia commented Mar 17, 2017

I think you need to describe the param here:

:param waiver_id: The waiver's id.

mjia commented Mar 17, 2017

jclien, thanks for this documentation, :-)

Edited Mar 17, 2017 by mjia

2 new commits added

Add documentation for all the HTTP endpoints in the API
Start a Sphinx docs project

Mar 17, 2017

jcline commented Mar 17, 2017

I added the missing parameter.

mjia commented Mar 22, 2017

Pull-Request has been merged by ralph

Mar 25, 2017

Metadata

Assignee

None

Tags

No Tags

waiverdb

#17 Create a docs project and add documentation for all the HTTP endpoints in the API Merged Mar 25, 2017 by ralph. Opened Mar 16, 2017 by jcline. jcline/waiverdb add-docs into master

Metadata

#17 Create a docs project and add documentation for all the HTTP endpoints in the API

Merged Mar 25, 2017 by ralph. Opened Mar 16, 2017 by jcline.

jcline/waiverdb add-docs into master