diff --git a/demo/wiremock/README.md b/demo/wiremock/README.md index c68698b..5f8501e 100644 --- a/demo/wiremock/README.md +++ b/demo/wiremock/README.md @@ -1,6 +1,6 @@ # Demo - WireMock on Testcontainers C -Demonstrates usage of the [WireMock Module for Testcontainers C](../../modules/wiremock/) in a simple main function. +Demonstrates usage of the [WireMock Module for Testcontainers C](../../modules/wiremock/README.md) in a simple main function. No test framework is used here. ## Running demo diff --git a/docs/architecture/README.md b/docs/architecture/README.md index 66cd711..249b736 100644 --- a/docs/architecture/README.md +++ b/docs/architecture/README.md @@ -31,5 +31,5 @@ This stage depends on the language and common practices there. Well, you build it. From the previous stages, you get a header file, binding libraries, -a shared library object or a DLL file from the [Testcontainers for C](./docs/c/README.md) module. +a shared library object or a DLL file from the [Testcontainers for C](../c/README.md) module. Then, you know the drill. diff --git a/docs/changelog.md b/docs/changelog.md index 8eb104b..76e5a9f 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -3,4 +3,3 @@ See [GitHub Releases](https://github.com/testcontainers/testcontainers-native/releases) ## ::github-release-changelog testcontainers/testcontainers-native - diff --git a/docs/cpp/README.md b/docs/cpp/README.md index 43ffe30..f6560ad 100644 --- a/docs/cpp/README.md +++ b/docs/cpp/README.md @@ -61,4 +61,4 @@ TEST_F(WireMockTestContainer, HelloWorld) { ## Demos -- [Using Testcontainers C in Google Test (C++)](../../demo/google-test/) +- [Using Testcontainers C in Google Test (C++)](../../demo/google-test/README.md) diff --git a/docs/getting-started.md b/docs/getting-started.md index 654c245..60ebca6 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -32,7 +32,7 @@ Any patches and issue reports are welcome! You can use a C/C++ framework for writing tests, e.g. CTest or CppUnit. Or you can just have a small launcher as presented below. -Below there is a code of the [WireMock demo](./demo/wiremock/) that only uses the library +Below there is a code of the [WireMock demo](../demo/wiremock/README.md) that only uses the library but not a specialized WireMock module (see below). Note that in this example, we do not terminate the container, diff --git a/mkdocs.yml b/mkdocs.yml index b55d683..2def411 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,6 +17,7 @@ docs_dir: . exclude_docs: | /_deps/** !.devcontainer + /build/_deps/** nav: - Documentation: @@ -61,8 +62,7 @@ plugins: paths: [src] - mkdocs_github_changelog: token: !ENV GITHUB_TOKEN - release_template: - match: 'v[0-9+].[0-9+].[0-9]+' + base_indent: 2 autoprocess: true enabled: true diff --git a/modules/wiremock/README.md b/modules/wiremock/README.md index eca3d9d..295a23b 100644 --- a/modules/wiremock/README.md +++ b/modules/wiremock/README.md @@ -15,11 +15,11 @@ for the list of modules for other languages. ## Sample output -[![Sample Output](../../demo/wiremock/sample_output.png)](../../demo/wiremock/) +[![Sample Output](../../demo/wiremock/sample_output.png)](../../demo/wiremock/README.md) ## Examples -- [Usage Demo](../../demo/wiremock/) +- [Usage Demo](../../demo/wiremock/README.md) ## Read more