b15809270d
This adds sphinx-based configs for doc generation, along with some templates and a new `docs/index.rst`. Still to come: updating the doc build script and merging Danny's autodoc changes.
48 lines
1.2 KiB
ReStructuredText
48 lines
1.2 KiB
ReStructuredText
oauth2client
|
|
============
|
|
|
|
*making OAuth2 just a little less painful*
|
|
|
|
``oauth2client`` makes it easy to interact with OAuth2-protected resources,
|
|
especially those related to Google APIs. You can also start with `general
|
|
information about using OAuth2 with Google APIs
|
|
<https://developers.google.com/accounts/docs/OAuth2>`_.
|
|
|
|
Getting started
|
|
---------------
|
|
|
|
We recommend installing via ``pip``::
|
|
|
|
$ pip install --upgrade oauth2client
|
|
|
|
You can also install from source::
|
|
|
|
$ git clone https://github.com/google/oauth2client
|
|
$ cd oauth2client
|
|
$ python setup.py install
|
|
|
|
Downloads
|
|
^^^^^^^^^
|
|
|
|
* `Most recent release tarball
|
|
<https://github.com/google/oauth2client/tarball/master>`_
|
|
* `Most recent release zipfile
|
|
<https://github.com/google/oauth2client/zipball/master>`_
|
|
* `Complete release list <https://github.com/google/oauth2client/releases>`_
|
|
|
|
Library Documentation
|
|
---------------------
|
|
|
|
* Complete library index: :ref:`genindex`
|
|
* Index of all modules: :ref:`modindex`
|
|
* Search all documentation: :ref:`search`
|
|
|
|
Contributing
|
|
------------
|
|
|
|
Please see the `contributing page
|
|
<http://google.github.io/oauth2client/contributing.html>`_ for more
|
|
information. In particular, we love pull requests -- but please make sure to
|
|
sign the contributor license agreement.
|
|
|