aboutsummaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorCraig Citro <craigcitro@gmail.com>2014-12-18 11:37:41 -0800
committerCraig Citro <craigcitro@gmail.com>2014-12-18 11:38:42 -0800
commitb15809270d38d87922bec255526d6d8011dc0ec4 (patch)
tree49084e8ed249bb1ed24a065271f930852aa89393 /docs/source
parent2f2c3b64c730b996f747724e042f623368fe1b40 (diff)
downloadoauth2client-b15809270d38d87922bec255526d6d8011dc0ec4.tar.gz
Switch doc building from epydoc to Sphinx.
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.
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/modules.rst7
-rw-r--r--docs/source/oauth2client.rst134
2 files changed, 141 insertions, 0 deletions
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
new file mode 100644
index 0000000..32a7349
--- /dev/null
+++ b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+oauth2client
+============
+
+.. toctree::
+ :maxdepth: 4
+
+ oauth2client
diff --git a/docs/source/oauth2client.rst b/docs/source/oauth2client.rst
new file mode 100644
index 0000000..3888bd9
--- /dev/null
+++ b/docs/source/oauth2client.rst
@@ -0,0 +1,134 @@
+oauth2client package
+====================
+
+Submodules
+----------
+
+oauth2client.appengine module
+-----------------------------
+
+.. automodule:: oauth2client.appengine
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.client module
+--------------------------
+
+.. automodule:: oauth2client.client
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.clientsecrets module
+---------------------------------
+
+.. automodule:: oauth2client.clientsecrets
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.crypt module
+-------------------------
+
+.. automodule:: oauth2client.crypt
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.django_orm module
+------------------------------
+
+.. automodule:: oauth2client.django_orm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.file module
+------------------------
+
+.. automodule:: oauth2client.file
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.gce module
+-----------------------
+
+.. automodule:: oauth2client.gce
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.keyring_storage module
+-----------------------------------
+
+.. automodule:: oauth2client.keyring_storage
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.locked_file module
+-------------------------------
+
+.. automodule:: oauth2client.locked_file
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.multistore_file module
+-----------------------------------
+
+.. automodule:: oauth2client.multistore_file
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.old_run module
+---------------------------
+
+.. automodule:: oauth2client.old_run
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.service_account module
+-----------------------------------
+
+.. automodule:: oauth2client.service_account
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.tools module
+-------------------------
+
+.. automodule:: oauth2client.tools
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.util module
+------------------------
+
+.. automodule:: oauth2client.util
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+oauth2client.xsrfutil module
+----------------------------
+
+.. automodule:: oauth2client.xsrfutil
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: oauth2client
+ :members:
+ :undoc-members:
+ :show-inheritance: