tests(git[sync]),docs: Improve git cmd docs, git sync tests (#432)

Author: tony

docs/cmd/git.md renamed to docs/cmd/git/index.md

@@ -2,13 +2,25 @@
 
 For `git(1)`.
 
-Compare to: [`fabtools.git`](https://fabtools.readthedocs.io/en/0.19.0/api/git.html#git-module),
+_Compare to: [`fabtools.git`](https://fabtools.readthedocs.io/en/0.19.0/api/git.html#git-module),
 [`salt.modules.git`](https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.git.html),
-[`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)
+[`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)_
+
+```{toctree}
+:caption: Subcommands
+:maxdepth: 1
+
+submodule
+remote
+stash
+```
 
 ```{eval-rst}
 .. automodule:: libvcs.cmd.git
    :members:
    :show-inheritance:
    :undoc-members:
+   :exclude-members: GitSubmoduleCmd,
+     GitRemoteCmd,
+     GitStashCmd
 ```

docs/cmd/git/remote.md

@@ -0,0 +1,10 @@
+# `remote`
+
+For `git-remote(1)`.
+
+```{eval-rst}
+.. autoclass:: libvcs.cmd.git.GitRemoteCmd
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/cmd/git/stash.md

@@ -0,0 +1,10 @@
+# `stash`
+
+For `git-stash(1)`.
+
+```{eval-rst}
+.. autoclass:: libvcs.cmd.git.GitStashCmd
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/cmd/git/submodule.md

@@ -0,0 +1,10 @@
+# `submodule`
+
+For `git-submodule(1)`.
+
+```{eval-rst}
+.. autoclass:: libvcs.cmd.git.GitSubmoduleCmd
+   :members:
+   :show-inheritance:
+   :undoc-members:
+```

docs/cmd/index.md

@@ -16,7 +16,7 @@ versions.
 ```{toctree}
 :caption: API
 
-git
+git/index
 hg
 svn
 ```

docs/redirects.txt

@@ -20,3 +20,4 @@
 "projects/git.md" "sync/git.md"
 "projects/hg.md" "sync/hg.md"
 "projects/svn.md" "sync/svn.md"
+"cmd/git.md" "cmd/git/index.md"

src/libvcs/cmd/git.py

@@ -24,7 +24,7 @@ def __init__(
         dir: StrPath,
         progress_callback: Optional[ProgressCallbackProtocol] = None,
     ) -> None:
-        """Lite, typed, pythonic wrapper for git(1).
+        r"""Lite, typed, pythonic wrapper for git(1).
 
         Parameters
         ----------
@@ -33,8 +33,28 @@ def __init__(
 
         Examples
         --------
-        >>> Git(dir=tmp_path)
+        >>> git = Git(dir=git_local_clone.dir)
+        >>> git
         <Git dir=...>
+
+        Subcommands:
+
+        >>> git.remote.show()
+        'origin'
+
+        >>> git.remote.add(
+        ...     name='my_remote', url=f'file:///dev/null'
+        ... )
+        ''
+
+        >>> git.remote.show()
+        'my_remote\norigin'
+
+        >>> git.stash.save(message="Message")
+        'No local changes to save'
+
+        >>> git.submodule.init()
+        ''
         """
         #: Directory to check out
         self.dir: pathlib.Path
@@ -2370,7 +2390,7 @@ def run(
         check_returncode: Optional[bool] = None,
         **kwargs: Any,
     ) -> str:
-        r"""Wraps `git submodule <https://git-scm.com/docs/git-remote>`_.
+        r"""Wraps `git remote <https://git-scm.com/docs/git-remote>`_.
 
         Examples
         --------
@@ -2405,7 +2425,7 @@ def add(
         log_in_real_time: bool = False,
         check_returncode: Optional[bool] = None,
     ) -> str:
-        """git submodule add
+        """git remote add
 
         Examples
         --------
@@ -2441,7 +2461,7 @@ def rename(
         log_in_real_time: bool = False,
         check_returncode: Optional[bool] = None,
     ) -> str:
-        """git submodule rename
+        """git remote rename
 
         Examples
         --------
@@ -2474,7 +2494,7 @@ def remove(
         log_in_real_time: bool = False,
         check_returncode: Optional[bool] = None,
     ) -> str:
-        """git submodule remove
+        """git remote remove
 
         Examples
         --------
@@ -2503,7 +2523,7 @@ def show(
         log_in_real_time: bool = False,
         check_returncode: Optional[bool] = None,
     ) -> str:
-        """git submodule show
+        """git remote show
 
         Examples
         --------
@@ -2538,7 +2558,7 @@ def prune(
         log_in_real_time: bool = False,
         check_returncode: Optional[bool] = None,
     ) -> str:
-        """git submodule prune
+        """git remote prune
 
         Examples
         --------
@@ -2572,7 +2592,7 @@ def get_url(
         log_in_real_time: bool = False,
         check_returncode: Optional[bool] = None,
     ) -> str:
-        """git submodule get-url
+        """git remote get-url
 
         Examples
         --------
@@ -2614,7 +2634,7 @@ def set_url(
         log_in_real_time: bool = False,
         check_returncode: Optional[bool] = None,
     ) -> str:
-        """git submodule set-url
+        """git remote set-url
 
         Examples
         --------