sphinxcontrib.repository¶
Define an implementation to handle each repository.
Implement Git repository.
-
class
sphinxcontrib.repository.git.GitRepository(max_count, *args, **kwargs)¶ -
property
branch_name¶ Represent branch name.
-
get_commit(revision)¶ Return Commit object of given revision.
- Parameters
revision (str) –
- Return type
Optional[git.objects.commit.Commit]
-
get_commit_url(revision)¶ Return the commit URL of given revision.
- Parameters
revision (str) –
- Return type
str
-
get_commits(revision=None, max_count=None, **kwargs)¶ Return List of Commit objects.
- Parameters
revision (Optional[str]) –
max_count (Optional[int]) –
kwargs (Any) –
- Return type
List[git.objects.commit.Commit]
-
get_diff(revision)¶ Return diff string of given revision.
- Parameters
revision (str) –
- Return type
str
-
property