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

Improve rendered documentation #2

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

Conversation

jannic
Copy link

@jannic jannic commented Oct 12, 2024

  • Add metadata so docs.rs calls cargo doc with --all-features
  • Include README.md in the top-level crate documentation

- Add metadata so docs.rs calls cargo doc with `--all-features`
- Include `README.md` in the top-level crate documentation
@jannic
Copy link
Author

jannic commented Oct 12, 2024

Sorry, the images referenced from README.md don't work when rendered via rustdoc.
This seems to be not supported by rustdoc, however there are workarounds, see rust-lang/rust#32104

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