civisanalytics / civis-python

Civis API Python Client
BSD 3-Clause "New" or "Revised" License
34 stars 26 forks source link

DOC Surface civis.find and civis.find_one in the Sphinx docs #250

Closed jacksonllee closed 6 years ago

jacksonllee commented 6 years ago

This PR surfaces civis.find and civis.find_one in the Sphinx docs, adds appropriate pointers, and fixes/updates various things in the function docstrings and Sphinx reStructuredText docs.

This PR resolves #235 directly, is a follow-up of #224, and addresses #170 more thoroughly.

I have built the docs locally to verify everything looks good and all new Sphinx ref links work as desired. For example, civis.find will look like this in the Sphinx docs:

screen shot 2018-04-23 at 11 06 51 am