docs: Fix autodoc linking

Author: tony

libvcs/git.py

@@ -1,17 +1,19 @@
 # -*- coding: utf-8 -*-
 """Git Repo object for libvcs.
 
-From https://github.com/saltstack/salt (Apache License):
+.. todo::
 
-- [`GitRepo.remote`](libvcs.git.GitRepo.remote) (renamed to ``remote``)
-- [`GitRepo.remote`](libvcs.git.GitRepo.remote_set) (renamed to ``set_remote``)
+    From https://github.com/saltstack/salt (Apache License):
 
-From pip (MIT Licnese):
+    - [`GitRepo.remote`](libvcs.git.GitRepo.remote) (renamed to ``remote``)
+    - [`GitRepo.remote`](libvcs.git.GitRepo.remote_set) (renamed to ``set_remote``)
 
-- [`GitRepo.remote`](libvcs.git.GitRepo.remote_set) (renamed to ``set_remote``)
-- [`GitRepo.convert_pip_url`](libvcs.git.GitRepo.convert_pip_url`) (``get_url_rev``)
-- [`GitRepo.get_revision`](libvcs.git.GitRepo.get_revision)
-- [`GitRepo.get_git_version`](libvcs.git.GitRepo.get_git_version)
+    From pip (MIT Licnese):
+
+    - [`GitRepo.remote`](libvcs.git.GitRepo.remote_set) (renamed to ``set_remote``)
+    - [`GitRepo.convert_pip_url`](libvcs.git.GitRepo.convert_pip_url`) (``get_url_rev``)
+    - [`GitRepo.get_revision`](libvcs.git.GitRepo.get_revision)
+    - [`GitRepo.get_git_version`](libvcs.git.GitRepo.get_git_version)
 """  # NOQA: E501
 from __future__ import absolute_import, print_function, unicode_literals
 
@@ -52,8 +54,7 @@ def extract_status(value) -> GitStatus:
 
     Returns
     -------
-    dict
-        Dictionary of git repo's status
+    Dictionary of git repo's status
     """
     pattern = re.compile(
         r"""[\n\r]?

libvcs/hg.py

@@ -1,11 +1,13 @@
 # -*- coding: utf-8 -*-
 """Mercurial Repo object for libvcs.
 
-The following is from pypa/pip (MIT license):
+.. todo::
 
-- [`MercurialRepo.convert_pip_url`](libvcs.hg.convert_pip_url)
-- [`MercurialRepo.get_url`](libvcs.hg.MercurialRepo.get_url)
-- [`MercurialRepo.get_revision`](libvcs.hg.MercurialRepo.get_revision)
+   The following is from pypa/pip (MIT license):
+
+   - [`MercurialRepo.convert_pip_url`](libvcs.hg.convert_pip_url)
+   - [`MercurialRepo.get_url`](libvcs.hg.MercurialRepo.get_url)
+   - [`MercurialRepo.get_revision`](libvcs.hg.MercurialRepo.get_revision)
 """  # NOQA E5
 from __future__ import absolute_import, print_function, unicode_literals
 

libvcs/shortcuts.py

@@ -2,20 +2,17 @@
 """Shortcuts"""
 from __future__ import absolute_import, print_function, unicode_literals
 
+from typing import Union
+
 from libvcs import GitRepo, MercurialRepo, SubversionRepo
 from libvcs.exc import InvalidPipURL, InvalidVCS
 
 
-def create_repo(url, vcs, **kwargs):
+def create_repo(url, vcs, **kwargs) -> Union[GitRepo, MercurialRepo, SubversionRepo]:
     r"""Return a object representation of a VCS repository.
 
-    Returns
-    -------
-    `libvcs.svn.SubversionRepo`, `libvcs.git.GitRepo`, or `libvcs.hg.MercurialRepo`.
-
     Examples
     --------
-
     >>> from libvcs.shortcuts import create_repo
     >>>
     >>> r = create_repo(
@@ -46,13 +43,11 @@ def create_repo(url, vcs, **kwargs):
         raise InvalidVCS('VCS %s is not a valid VCS' % vcs)
 
 
-def create_repo_from_pip_url(pip_url, **kwargs):
+def create_repo_from_pip_url(
+    pip_url, **kwargs
+) -> Union[GitRepo, MercurialRepo, SubversionRepo]:
     r"""Return a object representation of a VCS repository via pip-style url.
 
-    Returns
-    -------
-    `libvcs.svn.SubversionRepo`, `libvcs.git.GitRepo`, or `libvcs.hg.MercurialRepo`.
-
     Examples
     --------