Clean up docs

Author: ethantkoenig

docs/entities.rst

@@ -41,3 +41,15 @@ GogsTeam
 
 .. autoclass:: gogs_client.entities::GogsTeam()
     :members:
+
+GogsBranch
+----------
+
+.. autoclass:: gogs_client.entities::GogsBranch()
+    :members:
+
+GogsCommit
+----------
+
+.. autoclass:: gogs_client.entities::GogsCommit()
+    :members:

gogs_client/entities.py

@@ -101,7 +101,7 @@ class GogsRepo(GogsEntity):
 
     #: The owner of the repository
     #:
-    #: :type: entities.GogsUser
+    #: :type: :class:`~GogsUser`
     owner = attr.ib(convert=lambda parsed_json: GogsUser.from_json(parsed_json))
 
     #: The name of the repository
@@ -138,18 +138,18 @@ def urls(self):
         """
         URLs of the repository
 
-        :type: GogsRepo.Urls
+        :type: :class:`~GogsRepo.Urls`
         """
         return GogsRepo.Urls(self._html_url, self._clone_url, self._ssh_url)
 
     #: Permissions for the repository
     #:
-    #: :type: GogsRepo.Permissions
+    #: :type: :class:`~GogsRepo.Permissions`
     permissions = attr.ib(convert=lambda data: GogsRepo.Permissions.from_json(data))
 
     #: Gets the repository's parent, when a fork
     #:
-    #: :type: GogsRepo
+    #: :type: :class:`~GogsRepo`
     parent = attr.ib(convert=lambda data: GogsRepo.from_json(data) if data else None, default=None)
 
     #: The description of the repository
@@ -298,7 +298,7 @@ class GogsBranch(GogsEntity):
 
     #: The HEAD commit of the branch
     #:
-    #: :type: entities.GogsCommit
+    #: :type: :class:`~GogsCommit`
     commit = attr.ib(convert=lambda parsed_json: GogsCommit.from_json(parsed_json))
 
 

gogs_client/interface.py

@@ -198,12 +198,12 @@ def get_branch(self, auth, username, repo_name, branch_name):
         """
         Returns the branch with name ``branch_name`` in the repository with name ``repo_name``
         owned by the user with username ``username``.
-        
+
         :param auth.Authentication auth: authentication object 
         :param str username: username of owner of repository containing the branch
         :param str repo_name: name of the repository with the branch
         :param str branch_name: name of the branch to return
-        :return a branch
+        :return: a branch
         :rtype: GogsBranch
         :raises NetworkFailure: if there is an error communicating with the server
         :raises ApiFailure: if the request cannot be serviced
@@ -214,12 +214,13 @@ def get_branch(self, auth, username, repo_name, branch_name):
 
     def get_branches(self, auth, username, repo_name):
         """
-        Returns the branches in the repository with name ``repo_name`` owned by the user with username ``username``.
+        Returns the branches in the repository with name ``repo_name`` owned by the user
+        with username ``username``.
 
         :param auth.Authentication auth: authentication object 
         :param str username: username of owner of repository containing the branch
         :param str repo_name: name of the repository with the branch
-        :return a list of branches
+        :return: a list of branches
         :rtype: List[GogsBranch]
         :raises NetworkFailure: if there is an error communicating with the server
         :raises ApiFailure: if the request cannot be serviced