fix(docs): update docs reflecting new structure

Author: CarliJoy

.github/CONTRIBUTING.md

@@ -31,7 +31,7 @@ You need to have the following tools available to you:
 - Run `make install` to get `uv` to install all dependencies and set up `pre-commit`
   - **Recommended**: Run `make` or `make help` to see other commands available to you.
 - After this, you should have a working virtual environment and proceed with writing code with your favourite IDE
-- **TIP**: You can run `make core/tests` or `make modules/<my-module>/tests` to run the tests specifically for that to speed up feedback cycles
+- **TIP**: You can run `make core/tests` or `make community/<my-module>/tests` to run the tests specifically for that to speed up feedback cycles
 - You can also run `make lint` to run the `pre-commit` for the entire codebase.
 
 

.github/PULL_REQUEST_TEMPLATE/new_container.md

@@ -20,16 +20,12 @@ It helps reduce unnecessary work for you and the maintainers!
     So please use `fix(postgres):` or `fix(my_new_vector_db):` if you want to add or modify community modules.
     This may change in the future if we have a separate package released with community modules.
 - [ ] Your PR allows maintainers to edit your branch, this will speed up resolving minor issues!
-- [ ] The new container is implemented under `modules/*`
-  - Your module follows [PEP 420](https://peps.python.org/pep-0420/) with implicit namespace packages
-    (if unsure, look at other existing community modules)
-  - Your package namespacing follows `testcontainers.<modulename>.*`
-    and you DO NOT have an `__init__.py` above your module's level.
-  - Your module has its own tests under `modules/*/tests`
-  - Your module has a `README.rst` and hooks in the `.. auto-class` and `.. title` of your container
+- [ ] The new container is implemented under `src/testcontainers/community/<modulename>/`
+  - Your package namespacing follows `testcontainers.community.<modulename>.*`.
+  - Your module has its own tests under `tests/community/<modulename>/`
+  - Your module has a `docs/community/<modulename>.rst` with the `.. autoclass` and `.. title` of your container
   - Implement the new feature (typically in `__init__.py`) and corresponding tests.
 - [ ] Your module is added in `pyproject.toml`
-  - it is declared under `tool.hatch.build.targets.wheel` - see other community modules
   - it is declared under `project.optional-dependencies` with the same name as your module name,
     we still prefer adding _NO EXTRA DEPENDENCIES_, meaning `mymodule = []` is the preferred addition
     (see the notes at the bottom)

docs/community/generic.rst

@@ -11,7 +11,7 @@ FastAPI container that is using :code:`ServerContainer`
     >>> from testcontainers.core.waiting_utils import wait_for_logs
     >>> from testcontainers.core.image import DockerImage
 
-    >>> with DockerImage(path="./modules/generic/tests/samples/fastapi", tag="fastapi-test:latest") as image:
+    >>> with DockerImage(path="./tests/community/generic/samples/fastapi", tag="fastapi-test:latest") as image:
     ...     with ServerContainer(port=80, image=image) as fastapi_server:
     ...         delay = wait_for_logs(fastapi_server, "Uvicorn running on http://0.0.0.0:80")
     ...         fastapi_server.get_api_url = lambda: fastapi_server._create_connection_url() + "/api/v1/"
@@ -31,7 +31,7 @@ A more advance use-case, where we are using a FastAPI container that is using Re
     ...     redis_container_port = redis.port
     ...     redis_container_ip_address = redis.get_docker_client().bridge_ip(redis._container.id)
 
-    ...     with DockerImage(path="./modules/generic/tests/samples/advance_1", tag="advance-1:latest") as image:
+    ...     with DockerImage(path="./tests/community/generic/samples/advance_1", tag="advance-1:latest") as image:
     ...         web_server = ServerContainer(port=80, image=image)
     ...         web_server.with_env(key="REDIS_HOST", value=redis_container_ip_address)
     ...         web_server.with_env(key="REDIS_PORT", value=redis_container_port)

docs/contributing.md

@@ -30,7 +30,7 @@ You need to have the following tools available to you:
 - Run `make install` to get `uv` to install all dependencies and set up `pre-commit`
   - **Recommended**: Run `make` or `make help` to see other commands available to you.
 - After this, you should have a working virtual environment and proceed with writing code with your favorite IDE
-- **TIP**: You can run `make core/tests` or `make modules/<my-module>/tests` to run the tests specifically for that to speed up feedback cycles
+- **TIP**: You can run `make core/tests` or `make community/<my-module>/tests` to run the tests specifically for that to speed up feedback cycles
 - You can also run `make lint` to run the `pre-commit` for the entire codebase.
 
 ## Adding new modules
@@ -47,10 +47,12 @@ Once you've talked to the maintainers (we do our best to reply!) then you can pr
 
 ### Module documentation
 
-Leave examples for others with your mew module such as `modules/<new_module>/basic_example.py`. You can create as many examples as you want.
+Leave examples for others with your new module such as `docs/modules/<new_module>_example.py`. You can create as many examples as you want.
 
 Create a new `docs/modules/<new_module>.md` describing the basic use of the new container. There is a [starter template provided here](https://raw.githubusercontent.com/testcontainers/testcontainers-python/blob/main/docs/modules/template.md){:target="\_blank"}.
 
+Also create a `docs/community/<new_module>.rst` with the `.. autoclass` and `.. title` directives pointing at your container class — this is used by the Sphinx doctest runner.
+
 !!! important
 
     Make sure to add your new module to the sidebar nav in the `mkdocs.yml`

docs/index.rst

@@ -14,6 +14,7 @@ testcontainers-python facilitates the use of Docker containers for functional an
 
 .. toctree::
     :maxdepth: 1
+    :glob:
 
     core/README
     compose
@@ -78,7 +79,7 @@ Crafting containers that are based on custom images is supported by the `core` m
 
 This allows you to create containers from images that are not part of the modules provided by testcontainers-python.
 
-For common use cases, you can also use the generic containers provided by the `testcontainers-generic` module. Please check the `generic documentation <modules/generic/README.html>`_ for more information.
+For common use cases, you can also use the generic containers provided by the `testcontainers-generic` module. Please check the `generic documentation <community/generic.html>`_ for more information.
 (example: `ServerContainer` for running a FastAPI server)