Skip to content

Commit 2f659b9

Browse files
Docs: Fix links and changelog rendering (#64)
2 parents d12a532 + b8b619f commit 2f659b9

File tree

7 files changed

+8
-9
lines changed

7 files changed

+8
-9
lines changed

demo/wiremock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Demo - WireMock on Testcontainers C
22

3-
Demonstrates usage of the [WireMock Module for Testcontainers C](../../modules/wiremock/) in a simple main function.
3+
Demonstrates usage of the [WireMock Module for Testcontainers C](../../modules/wiremock/README.md) in a simple main function.
44
No test framework is used here.
55

66
## Running demo

docs/architecture/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@ This stage depends on the language and common practices there.
3131
Well, you build it.
3232
From the previous stages,
3333
you get a header file, binding libraries,
34-
a shared library object or a DLL file from the [Testcontainers for C](./docs/c/README.md) module.
34+
a shared library object or a DLL file from the [Testcontainers for C](../c/README.md) module.
3535
Then, you know the drill.

docs/changelog.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@
33
See [GitHub Releases](https://github.com/testcontainers/testcontainers-native/releases)
44

55
## ::github-release-changelog testcontainers/testcontainers-native
6-

docs/cpp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ TEST_F(WireMockTestContainer, HelloWorld) {
6161

6262
## Demos
6363

64-
- [Using Testcontainers C in Google Test (C++)](../../demo/google-test/)
64+
- [Using Testcontainers C in Google Test (C++)](../../demo/google-test/README.md)

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Any patches and issue reports are welcome!
3232

3333
You can use a C/C++ framework for writing tests, e.g. CTest or CppUnit.
3434
Or you can just have a small launcher as presented below.
35-
Below there is a code of the [WireMock demo](./demo/wiremock/) that only uses the library
35+
Below there is a code of the [WireMock demo](../demo/wiremock/README.md) that only uses the library
3636
but not a specialized WireMock module (see below).
3737

3838
Note that in this example, we do not terminate the container,

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ docs_dir: .
1717
exclude_docs: |
1818
/_deps/**
1919
!.devcontainer
20+
/build/_deps/**
2021
2122
nav:
2223
- Documentation:
@@ -61,8 +62,7 @@ plugins:
6162
paths: [src]
6263
- mkdocs_github_changelog:
6364
token: !ENV GITHUB_TOKEN
64-
release_template: <jinja2 str>
65-
match: 'v[0-9+].[0-9+].[0-9]+'
65+
base_indent: 2
6666
autoprocess: true
6767
enabled: true
6868

modules/wiremock/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ for the list of modules for other languages.
1515

1616
## Sample output
1717

18-
[![Sample Output](../../demo/wiremock/sample_output.png)](../../demo/wiremock/)
18+
[![Sample Output](../../demo/wiremock/sample_output.png)](../../demo/wiremock/README.md)
1919

2020
## Examples
2121

22-
- [Usage Demo](../../demo/wiremock/)
22+
- [Usage Demo](../../demo/wiremock/README.md)
2323

2424
## Read more
2525

0 commit comments

Comments
 (0)