Add a little doc

Author: martindurant

docs/source/api.rst

@@ -31,6 +31,7 @@ User Classes
     proj.conda_package.CondaRecipe
     proj.conda_package.RattlerRecipe
     proj.conda_project.CondaProject
+    artifact.container.Docker
     proj.documentation.MDBook
     proj.documentation.RTD
     proj.git.GitRepo
@@ -48,6 +49,7 @@ User Classes
 .. autoclass:: projspec.proj.conda_package.CondaRecipe
 .. autoclass:: projspec.proj.conda_package.RattlerRecipe
 .. autoclass:: projspec.proj.conda_project.CondaProject
+.. autoclass:: projspec.artifact.container.Docker
 .. autoclass:: projspec.proj.documentation.MDBook
 .. autoclass:: projspec.proj.documentation.RTD
 .. autoclass:: projspec.proj.git.GitRepo

src/projspec/artifact/container.py

@@ -5,6 +5,8 @@
 
 
 class DockerImage(BaseArtifact):
+    """Filesystem snapshot as created by bocker-build, which can be instantiated into a container."""
+
     def __init__(self, proj: Project, cmd=None, tag=None):
         if tag:
             cmd = ["docker", "build", ".", "-t", tag]
@@ -15,6 +17,8 @@ def __init__(self, proj: Project, cmd=None, tag=None):
 
 
 class DockerRuntime(DockerImage):
+    """Running container in Docker, tied to a certain image and command."""
+
     # Note: there are many optional arguments to docker; we could surface the most common
     #  ones (-it, -d, -p). This does the simplest thing.
 
@@ -38,6 +42,8 @@ def _make(self, *args, **kwargs) -> None:
 
 
 class Docker(ProjectExtra):
+    """A Dockerfile in a project directory, which defines how to build an image."""
+
     def match(self):
         return "Dockerfile" in self.proj.basenames
 

src/projspec/html.py

@@ -20,15 +20,17 @@ def dict_to_html(data: dict, title="Data", open_level=2) -> str:
     open = "open" if open_level > 0 else "closed"
 
     html = [
-        f'<details {open} style="margin-left: 20px; margin-bottom: 10px;"><summary style="cursor: pointer; color: #2c5aa0; padding: 5px;"><strong>{title}</strong></summary>'
+        f'<details {open} style="margin-left: 20px; margin-bottom: 10px;"><summary style="cursor: pointer;'
+        f' color: #2c5aa0; padding: 5px;"><strong>{title}</strong></summary>'
     ]
 
     for key, value in data.items():
         if isinstance(value, dict):
             html.append(dict_to_html(value, key, open_level - 1))
         elif isinstance(value, (list, tuple)):
             html.append(
-                f'<details style="margin-left: 20px; margin-bottom: 10px;"><summary style="cursor: pointer; color: #2c5aa0; padding: 5px;"><strong>{key}</strong></summary>'
+                f'<details style="margin-left: 20px; margin-bottom: 10px;"><summary style="cursor: pointer;'
+                f' color: #2c5aa0; padding: 5px;"><strong>{key}</strong></summary>'
             )
             for i, item in enumerate(value):
                 if isinstance(item, dict):