Run doctests for each package.

tillahoffmann · tillahoffmann · commit 304c4c59766a · 2023-01-06T11:01:37.000-05:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -22,5 +22,3 @@ jobs:
           pip install -r requirements/3.10.txt
       - name: Build documentation
         run: make docs
-      - name: Run doctests
-        run: make doctests
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -68,6 +68,9 @@ jobs:
       - name: Run tests
         if: matrix.component != 'meta'
         run: make ${{ matrix.component }}/tests
+      - name: Run doctests
+        if: matrix.component != 'meta'
+        run: make ${{ matrix.component }}/doctest
       - name: Build the package
         run: make ${{ matrix.component }}/dist
       - name: Upload the package to pypi
diff --git a/Makefile b/Makefile
@@ -12,6 +12,7 @@ UPLOAD = $(addsuffix /upload,${PACKAGES})
 # All */tests folders for each of the test suites.
 TESTS = $(addsuffix /tests,$(filter-out meta,${PACKAGES}))
 TESTS_DIND = $(addsuffix -dind,${TESTS})
+DOCTESTS = $(addsuffix /doctest,$(filter-out meta,${PACKAGES}))
 # All linting targets.
 LINT = $(addsuffix /lint,${PACKAGES})
 
@@ -56,9 +57,12 @@ ${TESTS_DIND} : %/tests-dind : image
 docs :
 	sphinx-build -nW . docs/_build
 
-doctests :
+doctest : ${DOCTESTS}
 	sphinx-build -b doctest . docs/_build
 
+${DOCTESTS} : %/doctest :
+	sphinx-build -b doctest -c doctests $* docs/_build
+
 # Targets to build requirement files
 requirements : ${REQUIREMENTS}
 ${REQUIREMENTS} : requirements/%.txt : requirements.in */setup.py
diff --git a/core/README.rst b/core/README.rst
@@ -2,3 +2,5 @@ testcontainers-core
 ===================
 
 :code:`testcontainers-core` is a utility package for spinning up Docker containers in testing environments.
+
+.. autoclass:: testcontainers.core.container.DockerContainer
diff --git a/core/testcontainers/core/container.py b/core/testcontainers/core/container.py
@@ -10,6 +10,17 @@
 
 
 class DockerContainer(object):
+    """
+    Basic container object to spin up Docker instances.
+
+    .. doctest::
+
+        >>> from testcontainers.core.container import DockerContainer
+        >>> from testcontainers.core.waiting_utils import wait_for_logs
+
+        >>> with DockerContainer("hello-world") as container:
+        ...    delay = wait_for_logs(container, "Hello from Docker!")
+    """
     def __init__(self, image, docker_client_kw: dict = None, **kwargs):
         self.env = {}
         self.ports = {}
diff --git a/doctests/conf.py b/doctests/conf.py
@@ -0,0 +1,5 @@
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+]
+master_doc = "README"
