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

Import README.md as crate documentation #127

Merged
merged 1 commit into from
Oct 12, 2023
Merged

Import README.md as crate documentation #127

merged 1 commit into from
Oct 12, 2023

Conversation

sksat
Copy link
Member

@sksat sksat commented Oct 12, 2023

概要

README を crate のドキュメントとして取り込む

詳細

cargo の external-doc を使って README.md を rustdoc として使う

検証結果

cargo doc --open して README.md の内容がトップページに取り込まれていればよし

影響範囲

docs.rs の c2a-core crate のトップページで README.md の内容が表示される

@sksat sksat added documentation Improvements or additions to documentation enhancement New feature or request priority::low priority low tools labels Oct 12, 2023
@sksat sksat requested a review from meltingrabbit October 12, 2023 10:55
@sksat sksat self-assigned this Oct 12, 2023
@sksat sksat merged commit 3adf042 into develop Oct 12, 2023
33 checks passed
@sksat sksat deleted the feature/import-readme-as-cargo-doc branch October 12, 2023 14:58
@meltingrabbit meltingrabbit mentioned this pull request Nov 1, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@meltingrabbit meltingrabbit meltingrabbit approved these changes

Assignees

@sksat sksat

Labels
documentation Improvements or additions to documentation enhancement New feature or request priority::low priority low tools
Projects
C2A public
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sksat @meltingrabbit