proptest-rs / proptest

Hypothesis-like property testing for Rust
Apache License 2.0
1.69k stars 158 forks source link

update docs links #314

Closed tzemanovic closed 1 year ago

tzemanovic commented 1 year ago

This PR updates links to the Book and Rustdoc to https://proptest-rs.github.io/proptest and https://docs.rs/proptest, respectively.

Additionally, there used to be a separate build for no-std deployed at https://altsysrq.github.io/rustdoc/proptest-nostd/latest/proptest/. Instead of 2 docs builds, the commit 274f6ad0e6da816dbf7cee9d5782df0770ebeb4e exposes features to the regular docs.rs build using the guide from https://users.rust-lang.org/t/how-to-document-optional-features-in-api-docs/64577/3

edit: docs.rs issue has been fixed

Do not merge yet - There seems to be an issue with the latest release on https://docs.rs/proptest/latest/proptest/ - for some reason the macros are not showing so the links from the book to the macros rustdoc are broken. They are showing in the prev version and when I build docs locally so not sure what's up with that

tzemanovic commented 1 year ago

looks great overall, but not sure what you mean by "for some reason the macros are not showing...", do you have a link?

thx! See https://docs.rs/proptest/1.1.0/proptest/index.html vs https://docs.rs/proptest/1.0.0/proptest/index.html - the former is missing the macros section and none of the macros appear elsewhere in the docs either (https://docs.rs/proptest/1.1.0/proptest/macro.prop_assert.html vs https://docs.rs/proptest/1.0.0/proptest/macro.prop_assert.html)

rex-remind101 commented 1 year ago

i see, wiled guess but is the addition of cfg_attr in various places causing that disappearance? if not then i agree that in issue should be filed with docs.rs

tzemanovic commented 1 year ago

i see, wiled guess but is the addition of cfg_attr in various places causing that disappearance? if not then i agree that in issue should be filed with docs.rs

It is from the last release so I don't think it could be, but I'm unable to reproduce it locally on that tag either. Thanks anyway! I've opened an issue here https://github.com/rust-lang/docs.rs/issues/2105

rex-remind101 commented 1 year ago

update with master and ci should get unblocked