Expand on source keys

.pylint.ini

@@ -135,6 +135,7 @@ disable=
     too-many-lines,
     line-too-long,
     too-many-locals,
+    too-many-statements,
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

gitman/cli.py

@@ -11,7 +11,7 @@
 from . import __version__, commands, common, exceptions
 
 
-def main(args=None, function=None):  # pylint: disable=too-many-statements
+def main(args=None, function=None):
     """Process command-line arguments and run the program."""
 
     # Shared options
@@ -242,7 +242,7 @@ def main(args=None, function=None):  # pylint: disable=too-many-statements
         sys.exit(1)
 
 
-def _get_command(function, namespace):  # pylint: disable=too-many-statements
+def _get_command(function, namespace):
     args: List = []
     kwargs: Dict = {}
 

gitman/models/source.py

@@ -31,6 +31,37 @@ class Source:
     | `links` | Creates symlinks within a project | No | `[]` |
     | `scripts` | Shell commands to run after checkout | No | `[]` |
 
+    ### Params
+
+    Params are passed directly to the `clone` command to modify behavior such as:
+
+    ```
+    # Shallow clone:
+    params: --depth=1
+
+    # Include submodules:
+    params: --recurse-submodules
+    ```
+
+    ### Sparse Paths
+
+    See [using sparse checkouts][using-sparse-checkouts] for more information.
+
+    ### Links
+
+    See [using multiple links][using-multiple-links] for more information.
+
+    ### Scripts
+
+    Scripts can be used to run post-checkout commands such us build steps. For example:
+
+    ```
+    repo: "https://github.com/koalaman/shellcheck"
+    scripts:
+      - brew install cabal-install
+      - cabal install
+    ```
+
     """
 
     repo: str = ""

mkdocs.yml

@@ -8,6 +8,7 @@ edit_uri: https://github.com/jacebrowning/gitman/edit/main/docs
 theme: readthedocs
 
 plugins:
+  - autorefs
   - mkdocstrings:
      watch:
         - gitman

tests/test_api.py

@@ -131,7 +131,7 @@ def it_does_not_modify_existing_config_file(config):
         expect(config.datafile.text) == CONFIG
 
 
-def describe_install():  # pylint: disable=too-many-statements
+def describe_install():
     def it_creates_missing_directories(config):
         shell.rm(config.location)