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

Support for cargo-external-doc #94

Closed
mathstuf opened this issue Jan 16, 2017 · 4 comments
Closed

Support for cargo-external-doc #94

mathstuf opened this issue Jan 16, 2017 · 4 comments

Comments

@mathstuf
Copy link

The tool is here. It would be nice to have the extra docs supplied with a project built on docs.rs as well. Not sure of the best way to indicate that extra documentation is available though. A Cargo.toml flag?

@JelteF
Copy link

JelteF commented Feb 2, 2017

This would really be super great. Right now my package is missing most of its documentation. See the links in this section: https://docs.rs/derive_more/0.5.0/derive_more/#generated-code

@9prady9
Copy link

9prady9 commented Mar 21, 2018

Similar is the case with arrayfire-rust documentation. It doesn't generate the documentation from external markdown files and thus tutorial links in docs.rs are broken.

@jyn514
Copy link
Member

jyn514 commented Nov 22, 2020

I think this is out of scope for docs.rs. The supported way to do this is either doc(include = "x.md") (rust-lang/rust#44732), which works today, or doc = include_str!(...) (soon to be merged in rust-lang/rust#78837), which will probably end up replacing it.

docs.rs doesn't run doc-tests so that bit of the tool isn't relevant, and documenting examples is tracked in a separate issue: #238.

@jyn514 jyn514 closed this as completed Nov 22, 2020
@mathstuf
Copy link
Author

I haven't investigated/ported my projects yet, but doc(include) is probably sufficient for me at least.

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

No branches or pull requests

4 participants