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.

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

Add --no-comment-extraction option #106

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Evian-Zhang
Copy link

Nowadays, Rustdoc supports to add comment from separate markdown files by

#![doc = include_str!("README.md")]

As a result, it is great to combine this feature with cargo readme to eliminate the annoything # lines for GitHub README readers (motivation can be seen here).

The ideal workflow is:

  1. User write a readme file README.rustdoc.md which is specific for rustdoc, and the lib.rs would include such readme file as documentation.

    In this file, code snippets are meant to be doc tested, and several # are added to hide lines.

  2. Then, user would use cargo readme to process such file, and generate a README.md for the repository.

    In this README, lines hidden by # are removed, and badges, licenses, etc. are added as template do.

However, current cargo readme cannot do this, since the file specified in --input option would still be treated as a Rust file, and the documentation would be extracted by matching the comment patterns. As a result, I add the --no-comment-extraction option, which would treat input file as a plain markdown file, and no more extraction is needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant