Fix: make docs fails with reference target not found

Author: VictorCavichioli

conf.py

@@ -168,4 +168,5 @@
 nitpick_ignore = [
     ("py:class", "typing_extensions.Self"),
     ("py:class", "docker.models.containers.ExecResult"),
+    ("py:class", "testcontainers.core.docker_client.ContainerInspectInfo"),
 ]

core/testcontainers/compose/compose.py

@@ -136,7 +136,11 @@ def reload(self) -> None:
         pass
 
     def get_container_info(self) -> Optional[ContainerInspectInfo]:
-        """Get container information via docker inspect (lazy loaded)."""
+        """Get container information via docker inspect (lazy loaded).
+
+        Returns:
+            Container inspect information or None if container is not started.
+        """
         if self._cached_container_info is not None:
             return self._cached_container_info
 

core/testcontainers/core/container.py

@@ -302,7 +302,11 @@ def exec(self, command: Union[str, list[str]]) -> ExecResult:
         return self._container.exec_run(command)
 
     def get_container_info(self) -> Optional[ContainerInspectInfo]:
-        """Get container information via docker inspect (lazy loaded)."""
+        """Get container information via docker inspect (lazy loaded).
+
+        Returns:
+            Container inspect information or None if container is not started.
+        """
         if self._cached_container_info is not None:
             return self._cached_container_info