mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2bc0ecd44b
rust/util/gh-pages/versions.html

92 lines
3.1 KiB
HTML
Raw Normal View History

Generate version index for docs domain index Uses basically the same code as the lint docs page as I didn't want to reinvent anything: A simple python script (inline in deploy script) writes an array of versions to a JSON file, which gets turned into a list of links using a bit of angular.js code. Fixes #1917
2017-08-03 14:17:12 -05:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Use the same <title> as <h1> on gh-pages
2019-02-28 12:17:10 -06:00
<title>Clippy lints documentation</title>
Generate version index for docs domain index Uses basically the same code as the lint docs page as I didn't want to reinvent anything: A simple python script (inline in deploy script) writes an array of versions to a JSON file, which gets turned into a list of links using a bit of angular.js code. Fixes #1917
2017-08-03 14:17:12 -05:00
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.6/css/bootstrap.min.css"/>
<style>
[ng\:cloak], [ng-cloak], [data-ng-cloak], [x-ng-cloak], .ng-cloak, .x-ng-cloak { display: none !important; }
</style>
</head>
<body>
<div class="container" ng-app="clippy" ng-controller="docVersions">
<div class="page-header">
fix a bunch of typos found by codespell
2018-07-25 13:02:52 -05:00
<h1>Clippy lints documentation</h1>
Generate version index for docs domain index Uses basically the same code as the lint docs page as I didn't want to reinvent anything: A simple python script (inline in deploy script) writes an array of versions to a JSON file, which gets turned into a list of links using a bit of angular.js code. Fixes #1917
2017-08-03 14:17:12 -05:00
</div>
<div ng-cloak>
<div class="alert alert-info" role="alert" ng-if="loading">
Loading&#x2026;
</div>
<div class="alert alert-danger" role="alert" ng-if="error">
Error loading versions!<br/>
You can always try to get <a href="master/index.html">the master branch docs</a>.
</div>
<article class="panel panel-default" ng-show="data">
<div class="panel-heading">
<h3 class="panel-title">
Available versions
</h3>
</div>
<ul class="list-group">
Docs index: Sort versions in a nice way This introduces a very sophisticated algorithm to determine the ordering of versions on the rendered docs' start page. (Spoiler alert: It maps "master" and "current" to the largest possible float values and converts a version like "1.2.3" to "1002003".)
2017-08-07 05:57:17 -05:00
<a class="list-group-item" ng-repeat="version in data | orderBy:versionOrder:true"
Generate version index for docs domain index Uses basically the same code as the lint docs page as I didn't want to reinvent anything: A simple python script (inline in deploy script) writes an array of versions to a JSON file, which gets turned into a list of links using a bit of angular.js code. Fixes #1917
2017-08-03 14:17:12 -05:00
href="./{{version}}/index.html">
Better version ordering of documentation
2020-02-13 10:32:29 -06:00
{{normalizeVersionDisplay(version)}}
Generate version index for docs domain index Uses basically the same code as the lint docs page as I didn't want to reinvent anything: A simple python script (inline in deploy script) writes an array of versions to a JSON file, which gets turned into a list of links using a bit of angular.js code. Fixes #1917
2017-08-03 14:17:12 -05:00
</a>
</ul>
</article>
</div>
</div>
rust-lang-nursery/rust-clippy => rust-lang/rust-clippy
2018-11-21 21:40:09 -06:00
<a href="https://github.com/rust-lang/rust-clippy">
Generate version index for docs domain index Uses basically the same code as the lint docs page as I didn't want to reinvent anything: A simple python script (inline in deploy script) writes an array of versions to a JSON file, which gets turned into a list of links using a bit of angular.js code. Fixes #1917
2017-08-03 14:17:12 -05:00
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"/>
</a>
<script src="https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.4.12/angular.min.js"></script>
<script>
angular.module('clippy', [])
.controller('docVersions', function ($scope, $http) {
$scope.loading = true;
Better version ordering of documentation
2020-02-13 10:32:29 -06:00
$scope.normalizeVersionDisplay = function(v) {
Docs index: Sort versions in a nice way This introduces a very sophisticated algorithm to determine the ordering of versions on the rendered docs' start page. (Spoiler alert: It maps "master" and "current" to the largest possible float values and converts a version like "1.2.3" to "1002003".)
2017-08-07 05:57:17 -05:00
return v.replace(/^v/, '');
};
Better version ordering of documentation
2020-02-13 10:32:29 -06:00
$scope.normalizeVersion = function(v) {
return v.replace(/^v/, '').replace(/^rust-/, '');
};
Docs index: Sort versions in a nice way This introduces a very sophisticated algorithm to determine the ordering of versions on the rendered docs' start page. (Spoiler alert: It maps "master" and "current" to the largest possible float values and converts a version like "1.2.3" to "1002003".)
2017-08-07 05:57:17 -05:00
$scope.versionOrder = function(v) {
if (v === 'master') { return Infinity; }
Rename current -> stable
2020-02-14 05:03:48 -06:00
if (v === 'stable') { return Number.MAX_VALUE; }
Also deploy from the beta branch
2020-03-25 14:01:11 -05:00
if (v === 'beta') { return Number.MAX_VALUE - 1; }
Docs index: Sort versions in a nice way This introduces a very sophisticated algorithm to determine the ordering of versions on the rendered docs' start page. (Spoiler alert: It maps "master" and "current" to the largest possible float values and converts a version like "1.2.3" to "1002003".)
2017-08-07 05:57:17 -05:00
return $scope.normalizeVersion(v)
.split('.')
.reverse()
.reduce(function(acc, val, index) {
return acc + (val * Math.pow(100, index));
}, 0);
}
Generate version index for docs domain index Uses basically the same code as the lint docs page as I didn't want to reinvent anything: A simple python script (inline in deploy script) writes an array of versions to a JSON file, which gets turned into a list of links using a bit of angular.js code. Fixes #1917
2017-08-03 14:17:12 -05:00
$http.get('./versions.json')
.success(function (data) {
$scope.data = data;
$scope.loading = false;
})
.error(function (data) {
$scope.error = data;
$scope.loading = false;
});
})
;
</script>
</body>
</html>
Reference in New Issue Copy Permalink