From fc4eff3185af49239712dcb32779a6c51b788136 Mon Sep 17 00:00:00 2001 From: Steve Kowalik Date: Sat, 11 Jan 2020 10:15:34 +1000 Subject: [PATCH] Fix all but one sphinx warnings (#1346) To hopefully correct our doc build, tidy up some of the warnings that sphinx complains about. The one remaining one is legitimate. --- doc/examples/Repository.rst | 10 ++++------ github/AuthenticatedUser.py | 6 +++--- github/Migration.py | 8 ++++---- github/Organization.py | 4 ++-- github/Project.py | 2 +- 5 files changed, 14 insertions(+), 16 deletions(-) diff --git a/doc/examples/Repository.rst b/doc/examples/Repository.rst index 9df1ab65..57397dc6 100644 --- a/doc/examples/Repository.rst +++ b/doc/examples/Repository.rst @@ -139,7 +139,7 @@ Delete a file in the repository {'commit': Commit(sha="0f40b0b4f31f62454f1758d7e6b384795e48fd96"), 'content': NotSet} Get the top 10 referrers over the last 14 days -------------------------------- +---------------------------------------------- .. code-block:: python @@ -154,7 +154,7 @@ Get the top 10 referrers over the last 14 days ] Get the top 10 popular contents over the last 14 days -------------------------------- +----------------------------------------------------- .. code-block:: python @@ -175,7 +175,7 @@ Get the top 10 popular contents over the last 14 days ] Get number of clones and breakdown for the last 14 days -------------------------------- +------------------------------------------------------- .. code-block:: python @@ -206,7 +206,7 @@ Get number of clones and breakdown for the last 14 days } Get number of views and breakdown for the last 14 days -------------------------------- +------------------------------------------------------ .. code-block:: python @@ -236,8 +236,6 @@ Get number of views and breakdown for the last 14 days ] } -======= -====== Mark the notifications of the repository as read ------------------------------------------------ diff --git a/github/AuthenticatedUser.py b/github/AuthenticatedUser.py index 5bdf88cc..25f56816 100644 --- a/github/AuthenticatedUser.py +++ b/github/AuthenticatedUser.py @@ -1215,7 +1215,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def get_invitations(self): """ - :calls: `GET /user/repository_invitations`_ + :calls: `GET /user/repository_invitations `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Invitation.Invitation` """ return github.PaginatedList.PaginatedList( @@ -1232,7 +1232,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): exclude_attachments=github.GithubObject.NotSet, ): """ - :calls: `POST /user/migrations`_ + :calls: `POST /user/migrations `_ :param repos: list or tuple of str :param lock_repositories: bool :param exclude_attachments: bool @@ -1263,7 +1263,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def get_migrations(self): """ - :calls: `GET /user/migrations`_ + :calls: `GET /user/migrations `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Migration.Migration` """ return github.PaginatedList.PaginatedList( diff --git a/github/Migration.py b/github/Migration.py index 94ae9110..02b8c958 100644 --- a/github/Migration.py +++ b/github/Migration.py @@ -130,7 +130,7 @@ class Migration(github.GithubObject.CompletableGithubObject): def get_status(self): """ - :calls: `GET /user/migrations/:migration_id`_ + :calls: `GET /user/migrations/:migration_id `_ :rtype: str """ headers, data = self._requester.requestJsonAndCheck( @@ -141,7 +141,7 @@ class Migration(github.GithubObject.CompletableGithubObject): def get_archive_url(self): """ - :calls: `GET /user/migrations/:migration_id/archive`_ + :calls: `GET /user/migrations/:migration_id/archive `_ :rtype: str """ headers, data = self._requester.requestJsonAndCheck( @@ -153,7 +153,7 @@ class Migration(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /user/migrations/:migration_id/archive`_ + :calls: `DELETE /user/migrations/:migration_id/archive `_ """ headers, data = self._requester.requestJsonAndCheck( "DELETE", @@ -163,7 +163,7 @@ class Migration(github.GithubObject.CompletableGithubObject): def unlock_repo(self, repo_name): """ - :calls: `DELETE /user/migrations/:migration_id/repos/:repo_name/lock`_ + :calls: `DELETE /user/migrations/:migration_id/repos/:repo_name/lock `_ :param repo_name: str :rtype: None """ diff --git a/github/Organization.py b/github/Organization.py index eb4439bd..8522a75d 100644 --- a/github/Organization.py +++ b/github/Organization.py @@ -1039,7 +1039,7 @@ class Organization(github.GithubObject.CompletableGithubObject): exclude_attachments=github.GithubObject.NotSet, ): """ - :calls: `POST /orgs/:org/migrations`_ + :calls: `POST /orgs/:org/migrations `_ :param repos: list or tuple of str :param lock_repositories: bool :param exclude_attachments: bool @@ -1070,7 +1070,7 @@ class Organization(github.GithubObject.CompletableGithubObject): def get_migrations(self): """ - :calls: `GET /orgs/:org/migrations`_ + :calls: `GET /orgs/:org/migrations `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Migration.Migration` """ return github.PaginatedList.PaginatedList( diff --git a/github/Project.py b/github/Project.py index a7e8062c..b52d54bc 100644 --- a/github/Project.py +++ b/github/Project.py @@ -156,7 +156,7 @@ class Project(github.GithubObject.CompletableGithubObject): def create_column(self, name): """ - calls: `POST https://developer.github.com/v3/projects/columns/#create-a-project-column>`_ + calls: `POST /projects/:project_id/columns `_ :param name: string """ assert isinstance(name, str), name