cargo-doc2readme

What's Changed

• Support GitHub alerts by @knutwalker in https://github.com/msrd0/cargo-doc2readme/pull/434

New Contributors

• @knutwalker made their first contribution in https://github.com/msrd0/cargo-doc2readme/pull/434

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.4.0...0.4.1

What's Changed

• Update pulldown-cmark and switch markdown rendering to pulldown-cmark-to-cmark by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/420

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.3.0...0.4.0

What's Changed

• Fix default template when details are missing by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/356
• Add repo icons for GitLab and Codeberg in default template by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/357
• Update cargo-metadata to 0.18 by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/355
• Several other dependency updates by @dependabot

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.2.6...0.3.0

What's Changed

• Fix default template missing newlines before links if doc ends with html by @LuckyTurtleDev in https://github.com/msrd0/cargo-doc2readme/pull/309

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.2.5...0.2.6

What's Changed

• Add "crate_version" variable to template by @LuckyTurtleDev in https://github.com/msrd0/cargo-doc2readme/pull/307
• Bump minijinja from 0.30.6 to 1.0.3 by @dependabot in #252, #264, #271, #274, #286, #293 and #303
• Bump ariadne from 0.2.0 to 0.3.0 by @dependabot in https://github.com/msrd0/cargo-doc2readme/pull/295
• Update syn to 2.0 by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/254

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.2.4...0.2.5

What's Changed

• Bump minijinja from 0.30.1 to 0.30.5 by @dependabot in https://github.com/msrd0/cargo-doc2readme/pull/231, https://github.com/msrd0/cargo-doc2readme/pull/235, https://github.com/msrd0/cargo-doc2readme/pull/236 and https://github.com/msrd0/cargo-doc2readme/pull/241
• Bump ariadne from 0.1.5 to 0.2.0 by @dependabot and @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/244

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.2.3...0.2.4

What's Changed

• Bump minijinja from 0.26.0 to 0.30.1 by @dependabot in #205, #216, #218 and #221
• Refactor custom test runner by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/225
• Warn when using doc attrs that involve macro expansion by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/226
• Ignore both std and core preludes by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/227

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.2.2...0.2.3

What's Changed

• Bump minijinja from 0.25.0 to 0.26.0 by @dependabot in https://github.com/msrd0/cargo-doc2readme/pull/186
• Update libtest-mimic to 0.5 by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/192
• Enable passing features flags to cargo when expanding macros by @LuckyTurtleDev in https://github.com/msrd0/cargo-doc2readme/pull/193
• Update clap to 4.0 and libtest-mimic to 0.6 by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/201
• Add -V and -p flags/options by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/202

New Contributors

• @LuckyTurtleDev made their first contribution in https://github.com/msrd0/cargo-doc2readme/pull/193

Thanks to @LuckyTurtleDev for their bug reports.

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.2.1...0.2.2

What's Changed

• Bump minijinja from 0.24.0 to 0.25.0 by @dependabot in https://github.com/msrd0/cargo-doc2readme/pull/179
• Fix error/warning spans by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/184
• Improve error message for workspace roots by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/185

Thanks to @LuckyTurtleDev for their bug reports.

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.2.0...0.2.1

What's Changed

• Remove deps.rs badge from readme by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/143
• Replace cargo dependency with cargo_metadata by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/142
• Add rust_version to template; Don't error on non-http urls by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/145
• Add --bin and --lib CLI flags by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/148
• Add custom test harness and test for nested lists by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/147
• Implement doc comment preprocessing to correctly trim indent by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/146
• Add more LinkTypes by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/150
• Use minijinja instead of tera by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/159
• Improve error reporting by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/163
• Fix optional deps skipped by cargo metadata by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/166
• Only include public items in scope by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/167
• Add target ("bin"/"lib") template variable by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/168
• Improve link generation by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/170
• Fix resolving types with generics by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/171
• Bump markdown version and add check testing by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/177

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.1.6...0.2.0

What's Changed

• Update cargo to 0.65 (Rust 1.64.0)

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.1.6...0.1.7

What's Changed

• Ensure nested lists don't alter the outer lists's appearance by @niluxv in https://github.com/msrd0/cargo-doc2readme/pull/140
• Always write a newline after a list by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/141

New Contributors

• @niluxv made their first contribution in https://github.com/msrd0/cargo-doc2readme/pull/140

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.1.5...0.1.6

This version introduces a problem where there might be a newline missing between lists and following paragraphs. Use Version 0.1.6 instead.

What's Changed

• Fix nested enumerated lists by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/139
• Fix doc links are not generated for functions that have a () after their name by @msrd0 in https://github.com/msrd0/cargo-doc2readme/commit/9aecd77ff4bf2b6b312cac2bfe8f318c55eb1a2e

Thanks to @LuckyTurtleDev and @niluxv for their bug reports.

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.1.4...0.1.5

What's Changed

• Fix endless recursion when resolving uses with name conflicts by @msrd0 in https://github.com/msrd0/cargo-doc2readme/pull/130

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.1.3...0.1.4

What's Changed

• if given "-" as the output file name, then use stdout. by @oylenshpeegul in https://github.com/msrd0/cargo-doc2readme/pull/120
• Bump cargo from 0.63.1 to 0.64.0 by @dependabot in https://github.com/msrd0/cargo-doc2readme/pull/124

New Contributors

• @oylenshpeegul made their first contribution in https://github.com/msrd0/cargo-doc2readme/pull/120

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.1.2...0.1.3

What's Changed

• Fix a bug where compatible versions were marked incompatible by @msrd0 in debf66b2c356d44f0ca216d41002625762f0a0fb
• Update the GitHub Actions example by @msrd0 in d627c1850a1a578362cd730d147e14451a5ca777

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.1.1...0.1.2

What's Changed

• Improve error message for virtual manifests by @msrd0 in 1304555197734d505d3f8535c439bf484e754407
• Fix the default template for manifests without a repository by @msrd0 in 77fbb6fdcb41199e05ae70afc8030a960e94a765
• Bump cargo from 0.62.0 to 0.63.0 by @msrd0 in 8e04b8efff5427818334f964da751a4b64a94f7c
• Enable stripping release binaries by @msrd0 in 09a409cbdee1d04d8f7797698209df5c5ea4654a
• Bump tera from to 1.16.0 and disable some builtins by @msrd0 in 96ff7f5370d1a155c8518e0e1559a2f64344317e
  This means that some filters that were previously available are no longer available. Removing the unmaintained chrono dependency is absolutely worth it though.

Thanks to @LuckyTurtleDev for their bug reports.

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.1.0...0.1.1

What's Changed

• Embed "dependency info" as a sort-of lock file into the readme by @msrd0
• Add --check option by @msrd0
• Fix paths starting with crate:: (#52) by @msrd0
• Add --lib/--bin flag when expanding macros (#54) by @msrd0
• Update cargo to 0.62 (Rust 1.61) by @msrd0 and @dependabot

Thanks to @pacak for their bug reports.

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.0.8...0.1.0

What's Changed

• Allow macro expansion by @scrabsha in https://github.com/msrd0/cargo-doc2readme/pull/38
• Update cargo to 0.58 (Rust 1.57) by @msrd0

New Contributors

• @scrabsha made their first contribution in https://github.com/msrd0/cargo-doc2readme/pull/38

Full Changelog: https://github.com/msrd0/cargo-doc2readme/compare/0.0.7...0.0.8

Changelog:

• Update cargo to 0.57 (Rust 1.56)