Skip to content

rustdocmd extracts specially marked Rustdoc comments directly from your Rust code and automatically generates Markdown documentation (e.g., for mdBook or README.md). This ensures your project documentation always stays in sync with the current state of your code.

License

Notifications You must be signed in to change notification settings

Suncompute/rustdocmd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rustdocmd

With this tool, you can write comprehensive, versioned documentation directly in your Rust code using rustdoc comments (/// or //!).

Specially marked sections are automatically extracted and output as standalone Markdown files.

This way, your code and comments become a complete, always up-to-date documentation that can be seamlessly and automatically integrated into systems like mdBook—ensuring your project documentation always matches the current state of your code.

The tool is still in a prototype stage and is continuously being developed.

👉 Buy Me a Coffee

About

rustdocmd extracts specially marked Rustdoc comments directly from your Rust code and automatically generates Markdown documentation (e.g., for mdBook or README.md). This ensures your project documentation always stays in sync with the current state of your code.

Resources

License

Stars

Watchers

Forks