Skip to content

Commit bd49fcc

Browse files
committed
changes for mkdocs build
1 parent 18f2985 commit bd49fcc

File tree

4 files changed

+14
-7
lines changed

4 files changed

+14
-7
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[step-summary]: https://cpp-linter.github.io/cpp-linter-rs/cli#-w-step-summary
66
[tidy-review]: https://cpp-linter.github.io/cpp-linter-rs/cli#-d-tidy-review
77
[format-review]: https://cpp-linter.github.io/cpp-linter-rs/cli#-m-format-review
8+
[other-licenses]: https://cpp-linter.github.io/cpp-linter-rs/other-licenses.md
89

910
[format-annotations-preview]: docs/docs/images/annotations-clang-format.png
1011
[tidy-annotations-preview]: docs/docs/images/annotations-clang-tidy.png
@@ -172,6 +173,8 @@ To provide feedback (requesting a feature or reporting a bug) please post to
172173

173174
## License
174175

175-
The scripts and documentation in this project are released under the [MIT].
176+
The scripts and documentation in this project are released under the [MIT] license.
176177

177-
Dependencies (that are redistributed by us in binary form) and their licenses, refer to [THIRD-PARTY LICENSES](docs/THIRD-PARTY-LICENSES.md).
178+
As for dependencies (that are redistributed by us in binary form) and their licenses, refer to [THIRD-PARTY LICENSES][other-licenses].
179+
180+
[MIT]: https://choosealicense.com/licenses/mit

docs/docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[step-summary]: cli.md#-w-step-summary
66
[tidy-review]: cli.md#-d-tidy-review
77
[format-review]: cli.md#-m-format-review
8+
[other-licenses]: other-licenses.md
89

910
[format-annotations-preview]: images/annotations-clang-format.png
1011
[tidy-annotations-preview]: images/annotations-clang-tidy.png

docs/THIRD-PARTY-LICENSES.md renamed to docs/docs/other-licenses.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1+
# Third-party Licenses
2+
13
- [clap](https://crates.io/crates/clap):
24
Dual-licensed under [Apache 2.0][Apache2] or [MIT].
35
- [git2](https://crates.io/crates/git2):
46
Dual-licensed under [Apache 2.0][Apache2] or [MIT].
57

6-
The following are conditionally included in binaries (using the `openssl-vendored` feature on a
7-
case-by-case basis) because it is a dependency of git2:
8+
The following are conditionally included in binaries (using the `openssl-vendored` feature on a
9+
case-by-case basis) because it is a dependency of git2:
810

9-
- [openssl](https://crates.io/crates/openssl): Licensed under [Apache 2.0][Apache2]
10-
- [openssl-probe](https://crates.io/crates/openssl-probe):
11-
Dual-licensed under [Apache 2.0][Apache2] or [MIT].
11+
- [openssl](https://crates.io/crates/openssl): Licensed under [Apache 2.0][Apache2]
12+
- [openssl-probe](https://crates.io/crates/openssl-probe):
13+
Dual-licensed under [Apache 2.0][Apache2] or [MIT].
1214

1315
- [lenient_semver](https://crates.io/crates/lenient_semver):
1416
Dual-licensed under [Apache 2.0][Apache2] or [MIT].

docs/mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ nav:
1212
- python.md
1313
- node.md
1414
- changelog.md
15+
- other-licenses.md
1516

1617
theme:
1718
name: material

0 commit comments

Comments
 (0)