add compose documentation and at least list the methods in DockerContainer

Author: alexanderankin

core/README.rst

@@ -3,7 +3,12 @@ Testcontainers Core
 
 :code:`testcontainers-core` is the core functionality for spinning up Docker containers in test environments.
 
-.. autoclass:: testcontainers.core.container.DockerContainer
+.. automodule:: testcontainers.core.container
+    :members:
+    :undoc-members:
+
+.. automodule:: testcontainers.core.network
+    :members:
 
 .. autoclass:: testcontainers.core.image.DockerImage
 
@@ -18,7 +23,8 @@ Compose
 
 It is also possible to use Docker Compose functionality:
 
-.. autoclass:: testcontainers.compose.compose.DockerCompose
+.. automodule:: testcontainers.compose.compose
+    :members:
 
 .. raw:: html
 

core/testcontainers/compose/compose.py

@@ -189,7 +189,7 @@ def docker_compose_command(self) -> list[str]:
         Returns command parts used for the docker compose commands
 
         Returns:
-            cmd: Docker compose command parts.
+            str: Docker compose command parts.
         """
         return self.compose_command_property
 
@@ -255,8 +255,8 @@ def get_logs(self, *services: str) -> tuple[str, str]:
         :param services: which services to get the logs for (or omit, for all)
 
         Returns:
-            stdout: Standard output stream.
-            stderr: Standard error stream.
+            str: stdout: Standard output stream.
+            str: stderr: Standard error stream.
         """
         logs_cmd = [*self.compose_command_property, "logs", *services]
 
@@ -362,9 +362,9 @@ def exec_in_container(
         :param command: the command to run in the container
 
         Returns:
-            stdout: Standard output stream.
-            stderr: Standard error stream.
-            exit_code: The command's exit code.
+            str: stdout: Standard output stream.
+            str: stderr: Standard error stream.
+            int: exit_code: The command's exit code.
         """
         if not service_name:
             service_name = self.get_container().Service

core/testcontainers/core/container.py

@@ -172,6 +172,9 @@ def get_wrapped_container(self) -> "Container":
         return self._container
 
     def get_docker_client(self) -> DockerClient:
+        """
+        :meta private:
+        """
         return self._docker
 
     def get_logs(self) -> tuple[bytes, bytes]:
@@ -190,6 +193,9 @@ def _configure(self) -> None:
 
 
 class Reaper:
+    """
+    :meta private:
+    """
     _instance: "Optional[Reaper]" = None
     _container: Optional[DockerContainer] = None
     _socket: Optional[socket] = None