Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cargo-readme does not read #![doc = r#"documentation"#] attributes #64

Open
msrd0 opened this issue Mar 14, 2021 · 2 comments
Open

cargo-readme does not read #![doc = r#"documentation"#] attributes #64

msrd0 opened this issue Mar 14, 2021 · 2 comments

Comments

@msrd0
Copy link
Contributor

msrd0 commented Mar 14, 2021

Using /*! <documentation> */ and //! <documentation> is basically just syntactic sugar for a #![doc = r#"<documentation>"#] attribute. However, cargo-readme does not currently parse those attributes, and generates an empty readme section.
@scrabsha
Copy link

I'm hitting this issue too. I think we could use the Rustc API, so that any #![doc = macro!()] will be properly handled too.

@msrd0
Copy link
Contributor Author

msrd0 commented Nov 19, 2021 •
edited
Loading

@scrabsha I've created cargo-doc2readme which does support this syntax (but is only available in alpha version)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@msrd0 @scrabsha