Rename GenerateDocumentation.py

github/GenerateReferenceOfClasses.py

@@ -0,0 +1,26 @@
+#!/bin/env python
+
+import GithubObjects
+
+def generateDocumentation():
+    classes = [ getattr( GithubObjects, c ) for c in dir( GithubObjects ) if hasattr( getattr( GithubObjects, c ), "_autoDocument" ) ]
+    doc = ""
+    for c in classes:
+        doc += c._autoDocument()
+    return doc
+
+if __name__ == "__main__":
+    print """\
+You don't normaly create instances of any class but `Github`.
+You obtain instances through calls to `get_` and `create_` methods.
+
+Class `Github`
+==============
+* Constructed from user's login and password
+* `get_user()`: `AuthenticatedUser`
+* `get_user( login )`: `NamedUser`
+* `get_organization( login )`: `Organization`
+* `get_gist( id )`: `Gist`
+* `get_gists()`: list of `Gist`
+"""
+    print generateDocumentation()