inline-doc 0.1.0

Embed markdown/text files as documentation
Documentation
  • Coverage
  • 0%
    0 out of 2 items documented0 out of 1 items with examples
  • Size
  • Source code size: 5.09 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 266.47 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 4s Average build duration of successful builds.
  • all releases: 4s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • RobertasJ/inline-doc
    1 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • RobertasJ

inline-doc

A working version of

#[doc = include_str!("path")]

Important to note that the path goes from the root of the project.

This project was inspired by lsp_doc and made to work on stable.

Example usage

#[inline_doc("src/docs/thing/documentation.md")]
struct Thing;

#[inline_doc("src/docs/thing.md")]
fn thing() {}

NOTE

When you change anything you need to restart rust-analyzer for the documentation to come into effect. rust-analyzer caches files so it wont update automatically.