Permalink
Browse files

doc: misc fixups

  • Loading branch information...
1 parent 6edd467 commit 939cf25a63da10c5c45493a2c2a3b014ea89d2db @mk-fg committed with Sep 22, 2012
Showing with 35 additions and 22 deletions.
  1. +24 −17 doc/api.md
  2. +7 −4 doc/api.rst
  3. +1 −0 doc/conf.py
  4. +2 −0 doc/sphinx_local_hooks.py
  5. +1 −1 setup.py
View
@@ -1,18 +1,3 @@
-* **exception skydrive.api\_v5.SkyDriveInteractionError**
-
- Bases: "exceptions.Exception"
-
-* **exception skydrive.api\_v5.ProtocolError(msg, code=None)**
-
- Bases: "skydrive.api\_v5.SkyDriveInteractionError"
-
-
- * \_\_init\_\_(msg, code=None)
-
-* **exception skydrive.api\_v5.AuthenticationError**
-
- Bases: "skydrive.api\_v5.SkyDriveInteractionError"
-
* **class skydrive.api\_v5.SkyDriveAuth(\*\*config)**
Bases: "object"
@@ -74,6 +59,11 @@
as "mobile" to use it.
+ * \_\_init\_\_(\*\*config)
+
+ Initialize API wrapper class with specified properties set.
+
+
* auth\_user\_get\_url(scope=None)
Build authorization URL for User Agent.
@@ -95,6 +85,13 @@
* api\_url\_base = 'https://apis.live.net/v5.0/'
+ * \_\_call\_\_(url='me/skydrive', query={}, query\_filter=True, auth\_header=False, auto\_refresh\_token=True, \*\*request\_kwz)
+
+ Make an arbitrary call to LiveConnect API.
+
+ Shouldn't be used directly under most circumstances.
+
+
* get\_quota()
Return tuple of (bytes_available, bytes_quota).
@@ -222,7 +219,17 @@
Bases: "skydrive.api\_v5.SkyDriveAPI", "skydrive.conf.ConfigMixin"
+* **exception skydrive.api\_v5.SkyDriveInteractionError**
- * auth\_get\_token(\*argz, \*\*kwz)
+ Bases: "exceptions.Exception"
- Refresh or acquire access_token.
+* **exception skydrive.api\_v5.ProtocolError(msg, code=None)**
+
+ Bases: "skydrive.api\_v5.SkyDriveInteractionError"
+
+
+ * \_\_init\_\_(msg, code=None)
+
+* **exception skydrive.api\_v5.AuthenticationError**
+
+ Bases: "skydrive.api\_v5.SkyDriveInteractionError"
View
@@ -1,5 +1,8 @@
.. automodule:: skydrive.api_v5
- :members:
- :undoc-members:
- :show-inheritance:
- :exclude-members: request
+ :exclude-members: request, SkyDriveAuth, SkyDriveAPI, PersistentSkyDriveAPI
+
+ .. autoclass:: SkyDriveAuth
+ .. autoclass:: SkyDriveAPI
+
+ .. autoclass:: PersistentSkyDriveAPI
+ :exclude-members: auth_get_token
View
@@ -22,3 +22,4 @@
autoclass_content = 'class'
autodoc_member_order = 'bysource'
+autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
@@ -55,6 +55,8 @@ def skip_override(app, what, name, obj, skip, options):
if what == 'exception':
return False if name == '__init__'\
and isinstance(obj, types.UnboundMethodType) else True
+ elif what == 'class' and name in ['__init__', '__call__']\
+ and isinstance(obj, types.UnboundMethodType): return False
return skip
def setup(app):
View
@@ -12,7 +12,7 @@
setup(
name = 'python-skydrive',
- version = '12.09.32',
+ version = '12.09.33',
author = 'Mike Kazantsev',
author_email = 'mk.fraggod@gmail.com',
license = 'WTFPL',

0 comments on commit 939cf25

Please sign in to comment.