1. Ian Cordasco
  2. github3.py

Commits

Ian Cordasco  committed a53d59d

Document GitHubStatus

Modify HISTORY to reflect GitHubStatus and add HISTORY to the docs index.

  • Participants
  • Parent commits 361be8c
  • Branches master

Comments (0)

Files changed (5)

File docs/github.rst

View file
 
 .. links
 .. _here: examples/githubex.html
+
+GitHubEnterprise Object
+-----------------------
+
+This has all of the same attributes ass the :class:`GitHub <GitHub>` object so 
+for brevity's sake, I'm not listing all of it's inherited members.
+
+.. autoclass:: GitHubEnterprise
+    :members:
+
+GitHubStatus Object
+-------------------
+
+.. autoclass:: GitHubStatus
+    :members:

File docs/index.rst

View file
 
 .. _requests: https://github.com/kennethreitz/requests
 
-
-API Coverage
-------------
-
-- Gists
-
-  - Comments
-
-- Git Data
-
-  - Blobs
-  - Commits
-  - References
-  - Tags
-  - Trees
-
-- Issues
-
-  - Comments
-  - Events
-  - Labels
-  - Milestones
-
-- Orgs
-
-  - Members
-  - Teams
-
-- Pull Requests
-
-  - Review Comments
-
-- Repos
-
-  - Collaborators
-  - Comments
-  - Commits
-  - Contents
-  - Downloads
-  - Forks
-  - Keys
-  - Watching
-  - Hooks
-
-- Users
-
-  - Emails
-  - Followers
-  - Keys
-
-- Events
-
-  - Types
-
-- Search
-
-- Markdown
-
 Contributing
 ------------
 
 - Mailing list: github3.py [at] librelist.com
 
 .. _sigmavirus24: https://twitter.com/sigmavirus24
+
+.. include:: ../HISTORY.rst

File github3/__init__.py

View file
 __version__ = '0.3.b'
 
 from github3.api import *
-from github3.github import GitHub
+from github3.github import GitHub, GitHubEnterprise, GitHubStatus
 from github3.models import GitHubError
 
 # flake8: noqa

File github3/api.py

View file
 
 """
 
-from .github import GitHub, GitHubEnterprise  # NOQA
+from .github import GitHub
 
 gh = GitHub()
 

File github3/github.py

View file
 class GitHub(GitHubCore):
     """Stores all the session information.
 
-    Logging In
-    ----------
-
     There are two ways to log into the GitHub API
 
     ::
 
     @classmethod
     def api(self):
+        """GET /api.json"""
         return self._recipe('api.json')
 
     @classmethod
     def status(self):
+        """GET /api/status.json"""
         return self._recipe('api', 'status.json')
 
     @classmethod
     def last_message(self):
+        """GET /api/last-message.json"""
         return self._recipe('api', 'last-message.json')
 
     @classmethod
     def messages(self):
+        """GET /api/messages.json"""
         return self._recipe('api', 'messages.json')