civisanalytics / civis-python

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

DOC Coalesce README.rst and index.rst #254

Closed jacksonllee closed 6 years ago

jacksonllee commented 6 years ago

This PR merges the repo's top-level README.rst and the Sphinx docs-specifics index.rst. The end result is that README.rst is the single source of truth for such items as installation and API keys, whereas index.rst is now minimal and contains (i) markers that draw text from README.rst and (ii) items specific to Sphinx docs such as toctree.

For the new README.rst, please check it out at my fork: https://github.com/jacksonllee/civis-python/blob/coalesce-readme-index-rst/README.rst

For the new index.rst, the compiled Sphinx docs will look like this:

python-client-sphinx-docs

Resolves #253.