rust-core_io icon indicating copy to clipboard operation
rust-core_io copied to clipboard

Upload crate documentation somewhere and point crates.io there

Open whitequark opened this issue 9 years ago • 8 comments

This is useful if I want to determine exactly which parts are available in core-io without trying to use them with rustc. Seems trivial as there's already a doc.sh script; so only Travis upload is needed.

whitequark avatar Sep 20 '16 01:09 whitequark

To give an example, I'm using this .travis.yml script for doc upload. The "secure" string is a personal GitHub token, encoded with travis encrypt CLI tool; travis encrypt GH_TOKEN=00000...

whitequark avatar Sep 20 '16 01:09 whitequark

I don't think the title of this issue matches what you're asking for?

jethrogb avatar Sep 20 '16 04:09 jethrogb

Sorry, I typoed. Fixed the title now.

To be clear on what I want: the "Documentation" link on https://crates.io/crates/core-io points to the Rust nightly documentation. I think it should point to generated documentation for this crate. Since it does not appear to currently exist anywhere, I suggest a way to upload it using Travis. I don't have a preference on where exactly it is.

whitequark avatar Sep 20 '16 05:09 whitequark

~~As an alternative you could simply link here: https://docs.rs/crate/core_io.~~ Nevermind, that has failed to build the docs because they use a newer nightly...

whitequark avatar Nov 01 '16 07:11 whitequark

That works now with the latest release, but it doesn't let you select between features.

jethrogb avatar Nov 06 '16 05:11 jethrogb

That's quite excellent already, and enough for my purposes. Thanks!

whitequark avatar Nov 06 '16 07:11 whitequark

Maybe you should fix the build on docs.rs and link there?

dhardy avatar Dec 08 '17 14:12 dhardy

It's quite hard to keep up to date with docs.rs because it's not known a priori which nightly they're using to build the docs.

jethrogb avatar Dec 08 '17 17:12 jethrogb