Skip to content

Commit ba698a4

Browse files
committed
fix sphinx docs build
1 parent f4b2278 commit ba698a4

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

modules/mailpit/README.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1+
.. autoclass:: testcontainers.mailpit.MailpitUser
12
.. autoclass:: testcontainers.mailpit.MailpitContainer
23
.. title:: testcontainers.mailpit.MailpitContainer

modules/mailpit/testcontainers/mailpit/__init__.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
1111
# License for the specific language governing permissions and limitations
1212
# under the License.
13-
import logging
1413
import os
1514
import tempfile
1615
from datetime import UTC, datetime, timedelta
@@ -27,10 +26,10 @@
2726
from testcontainers.core.container import DockerContainer
2827
from testcontainers.core.waiting_utils import wait_for_logs
2928

30-
logger = logging.getLogger(__name__)
31-
3229

3330
class MailpitUser(NamedTuple):
31+
"""Mailpit user for authentication"""
32+
3433
username: str
3534
password: str
3635

@@ -43,9 +42,9 @@ class MailpitContainer(DockerContainer): # type: ignore[misc]
4342
user/password.
4443
4544
Options:
46-
- require_tls = True forces the use of SSL
47-
- users = [MailpitUser("jane", "secret"), MailpitUser("ron", "pass2")] only
48-
allows login with jane:secret or ron:pass2
45+
- ``require_tls = True`` forces the use of SSL
46+
- ``users = [MailpitUser("jane", "secret"), MailpitUser("ron", "pass2")]``
47+
only allows login with ``jane:secret`` or ``ron:pass2``
4948
5049
Example:
5150
@@ -65,7 +64,6 @@ class MailpitContainer(DockerContainer): # type: ignore[misc]
6564
... code, _ = server.login("any", "auth")
6665
... assert code == 235 # authentication successful
6766
... # use server.sendmail(...) to send emails
68-
6967
"""
7068

7169
def __init__( # type: ignore[no-untyped-def]

0 commit comments

Comments
 (0)