Skip to content

Add docs.rs integration #676

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.

Sign up for GitHub

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
carols10cents merged 4 commits into from
May 2, 2017
Merged

Add docs.rs integration #676

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
11e5e99
Add docs.rs integration
kureuil Apr 10, 2017
a13a6da
Don't force lib name to be the crate name in docs.rs link
kureuil Apr 15, 2017
bb622ce
Fix version number being undefined when crate only has unstable versions
kureuil Apr 15, 2017
c025fbb
Fix auto-documentation link not being updated on version change
kureuil May 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions app/routes/crate/version.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ export default Ember.Route.extend({

model(params) {
const requestedVersion = params.version_num === 'all' ? '' : params.version_num;

const crate = this.modelFor('crate');
const controller = this.controllerFor(this.routeName);
const maxVersion = crate.get('max_version');
Expand All @@ -35,6 +34,20 @@ export default Ember.Route.extend({
return result;
};

const fetchCrateDocumentation = () => {
if (!crate.get('documentation') ||
crate.get('documentation').substr(0, 16) === 'https://docs.rs/') {
let crateName = crate.get('name');
let crateVersion = params.version_num;
ajax(`https://docs.rs/crate/${crateName}/${crateVersion}/builds.json`)
.then((r) => {
if (r.length > 0 && r[0].build_status === true) {
crate.set('documentation', `https://docs.rs/${crateName}/${crateVersion}/`);
}
});
}
};

// Fallback to the crate's last stable version
// If `max_version` is `0.0.0` then all versions have been yanked
if (!requestedVersion && maxVersion !== '0.0.0') {
Expand All @@ -52,10 +65,13 @@ export default Ember.Route.extend({
} else {
params.version_num = latestStableVersion.get('num');
}
});
}).then(fetchCrateDocumentation);
} else {
params.version_num = maxVersion;
fetchCrateDocumentation();
}
} else {
fetchCrateDocumentation();
}

controller.set('crate', crate);
Expand Down