Skip to content

v0.7.0

Latest

Choose a tag to compare

@github-actions github-actions released this 11 Aug 04:49
· 187 commits to main since this release

What's Changed

Fixed

  • Fix a bug that could cause cargo sync-rdme to panic when converting documentation containing valid intra-doc links that cargo-sync-rdme cannot resolve. (#702 by @gifnksm)

Changed

  • Emit resolved intra-doc links as reference-style Markdown links instead of expanding them to inline links with resolved URLs. (#708 by @gifnksm)

    Inline intra-doc links are converted to generated reference-style links. Existing intra-doc reference links keep their labels and reference form when possible, and cargo-sync-rdme adds or adjusts reference definitions as needed to keep the output valid. Non-intra-doc links are left unchanged.

  • Add title attributes to resolved intra-doc links after expansion so generated Markdown matches rustdoc more closely. (#712 by @gifnksm)

    Resolved intra-doc links now carry titles such as "struct crate::Type" in generated reference definitions. Existing explicit Markdown titles are preserved.

  • Match rustdoc more closely for namespace-qualified intra-doc links such as [struct@Struct] by omitting the namespace@ prefix from the rendered link text while still resolving the link to the namespace-qualified target. (#711 by @gifnksm)

Removed

  • Stop publishing prebuilt Linux release artifacts for i686-unknown-linux-gnu. (#700 by @gifnksm)

Other Pull Requests

  • Run cargo-deny with install-action by @gifnksm in #701
  • Use inline tables in config docs and tests by @gifnksm in #699
  • Add sync-rdme coverage job by @gifnksm in #703
  • Match pulldown-cmark options with rustdoc by @gifnksm in #704
  • chore: update dependencies by @gifnksm-update-bot[bot] in #705
  • Reorganize example library docs by @gifnksm in #706
  • Document rustdoc markdown extensions by @gifnksm in #707
  • Escape generated reference labels by @gifnksm in #709
  • Disable pulldown-cmark default features by @gifnksm in #710
  • Refine documentation wording and guidance by @gifnksm in #713

Full Changelog: v0.6.0...v0.7.0