testcontainers-python icon indicating copy to clipboard operation
testcontainers-python copied to clipboard

Bug: Docs links for some core modules are gone

Open ehossack opened this issue 11 months ago • 5 comments

Describe the bug

Previously I could access the links to core modules like DockerCompose within read the docs, e.g. this link which was in my codebase: https://testcontainers-python.readthedocs.io/en/latest/compose.html#testcontainers.compose.DockerCompose

Now the link is gone.

To Reproduce

Visit https://testcontainers-python.readthedocs.io/en/latest/compose.html#testcontainers.compose.DockerCompose, observe no docs

Runtime environment

Seems like any v4+ version of the docs.

ehossack avatar Jan 30 '25 21:01 ehossack

It appears all of the module docs are gone as part of this. This link is essentially blank now - https://testcontainers-python.readthedocs.io/en/latest/modules/index.html

reallistic avatar Apr 03 '25 16:04 reallistic

to be fair they are there for the latest released version - https://testcontainers-python.readthedocs.io/en/testcontainers-v4.10.0/modules/

help is welcome to figure this one out

On Thu, Apr 3, 2025 at 9:37 AM Michael @.***> wrote:

It appears all of the module docs are gone as part of this. This link is essentially blank now - https://testcontainers-python.readthedocs.io/en/latest/modules/index.html

— Reply to this email directly, view it on GitHub https://github.com/testcontainers/testcontainers-python/issues/763#issuecomment-2776371469, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACECGJHPG3ABIUUY3FZUCRD2XVPT3AVCNFSM6AAAAABWGGNCEWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDONZWGM3TCNBWHE . You are receiving this because you are subscribed to this thread.Message ID: @.*** com> [image: reallistic]reallistic left a comment (testcontainers/testcontainers-python#763) https://github.com/testcontainers/testcontainers-python/issues/763#issuecomment-2776371469

It appears all of the module docs are gone as part of this. This link is essentially blank now - https://testcontainers-python.readthedocs.io/en/latest/modules/index.html

— Reply to this email directly, view it on GitHub https://github.com/testcontainers/testcontainers-python/issues/763#issuecomment-2776371469, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACECGJHPG3ABIUUY3FZUCRD2XVPT3AVCNFSM6AAAAABWGGNCEWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDONZWGM3TCNBWHE . You are receiving this because you are subscribed to this thread.Message ID: @.*** com>

alexanderankin avatar Apr 03 '25 16:04 alexanderankin

Got it thanks for the link. I'll take a quick peek, but unfortunately, I am unfamiliar with readthedocs.

reallistic avatar Apr 03 '25 16:04 reallistic

fixed - https://testcontainers-python.readthedocs.io/en/latest/modules/index.html - still have to figure out how it happened and maybe prevent in future

alexanderankin avatar Apr 03 '25 17:04 alexanderankin

@alexanderankin I can't find DockerCompose class documentation there https://testcontainers-python.readthedocs.io/en/latest/compose.html#testcontainers.compose.DockerCompose

jorgehermo9 avatar Apr 22 '25 10:04 jorgehermo9