Skip to content

Use docs.rs as default documentation #1895

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

Merged
merged 1 commit into from
Oct 2, 2019
Merged

Conversation

taiki-e
Copy link
Member

@taiki-e taiki-e commented Oct 1, 2019

docs-rs uses the latest nightly since September 30th, so I think the problem has been resolved.

cc #1637

Closes #1105

cc @cramertj @Nemo157

@cramertj
Copy link
Member

cramertj commented Oct 1, 2019

It looks like some of the URLs no longer include an explicit version number, while others do. Is that intentional?

@taiki-e
Copy link
Member Author

taiki-e commented Oct 1, 2019

Yes, this is intentional. IIUC, only html_root_url requires an explicit version number and is not required elsewhere.

@cramertj
Copy link
Member

cramertj commented Oct 1, 2019

Do you think there's any benefit to continuing to specify an explicit version so that the published package points to the correct version of the docs, or do you think it doesn't matter?

@taiki-e
Copy link
Member Author

taiki-e commented Oct 2, 2019

In pre-release versions, there are breaking changes from version to version, so it would probably make sense to link to the explicit version of the document. Other than that, cargo basically chooses the latest version, and the changes are backward compatible, so I don't think there is much merit to link to the explicit version, but it still makes sense when considering the increase in major (minor) versions.

@taiki-e
Copy link
Member Author

taiki-e commented Oct 2, 2019

@cramertj Updated to use explicit version numbers.

@cramertj
Copy link
Member

cramertj commented Oct 2, 2019

Thanks! Looks like travis failure is a new ICE, so this should be good to merge.

@cramertj cramertj merged commit 95c47df into rust-lang:master Oct 2, 2019
@taiki-e taiki-e deleted the docs-rs branch October 2, 2019 19:19
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.

docs.rs fails for 0.3.0-alpha.1 and up
2 participants