Skip to content

Commit

Permalink
Add outdated docs warning to old versions (#293)
Browse files Browse the repository at this point in the history
  • Loading branch information
@lgoettgens
lgoettgens authored Jul 3, 2024
1 parent 5ae9620 commit 99329c1
Show file tree
Hide file tree
Showing 48 changed files with 2,112 additions and 144 deletions.
49 changes: 45 additions & 4 deletions v0.1.0/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · Aqua.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link href="assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>Aqua.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="search/"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li class="current"><a class="toctext" href>Home</a><ul class="internal"></ul></li></ul></nav><article id="docs"><header><nav><ul><li><a href>Home</a></li></ul><a class="edit-page" href="https://github.com/tkf/Aqua.jl/blob/master/docs/src/index.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Home</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Aqua.jl-1" href="#Aqua.jl-1">Aqua.jl</a></h1><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Aqua.Aqua" href="#Aqua.Aqua"><code>Aqua.Aqua</code></a> — <span class="docstring-category">Module</span>.</div><div><div><p><strong>Aqua.jl: <em>A</em>uto <em>QU</em>ality <em>A</em>ssurance for Julia packages</strong></p><p><a href="https://tkf.github.io/Aqua.jl/stable"><img src="https://img.shields.io/badge/docs-stable-blue.svg" alt="Stable"/></a> <a href="https://tkf.github.io/Aqua.jl/dev"><img src="https://img.shields.io/badge/docs-dev-blue.svg" alt="Dev"/></a> <a href="https://travis-ci.com/tkf/Aqua.jl"><img src="https://travis-ci.com/tkf/Aqua.jl.svg?branch=master" alt="Build Status"/></a> <a href="https://codecov.io/gh/tkf/Aqua.jl"><img src="https://codecov.io/gh/tkf/Aqua.jl/branch/master/graph/badge.svg" alt="Codecov"/></a> <a href="https://coveralls.io/github/tkf/Aqua.jl?branch=master"><img src="https://coveralls.io/repos/github/tkf/Aqua.jl/badge.svg?branch=master" alt="Coveralls"/></a> <a href="https://github.com/tkf/Aqua.jl"><img src="https://img.shields.io/badge/Aqua.jl-%F0%9F%8C%A2-aqua.svg" alt="Aqua QA"/></a></p><p><strong>Usage</strong></p><p>Call <code>Aqua.test_all(YourPackage)</code> from <code>test/runtests.jl</code>, e.g.,</p><pre><code class="language-julia">using YourPackage
<!DOCTYPE html><HTML lang="en"><head><meta charset="UTF-8"/><meta content="width=device-width, initial-scale=1.0" name="viewport"/><title>Home · Aqua.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script data-main="assets/documenter.js" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link href="assets/documenter.css" rel="stylesheet" type="text/css"/><script data-outdated-warner="">function maybeAddWarning () {
const head = document.getElementsByTagName('head')[0];

// Add a noindex meta tag (unless one exists) so that search engines don't index this version of the docs.
if (document.body.querySelector('meta[name="robots"]') === null) {
const meta = document.createElement('meta');
meta.name = 'robots';
meta.content = 'noindex';

head.appendChild(meta);
};

// Add a stylesheet to avoid inline styling
const style = document.createElement('style');
style.type = 'text/css';
style.appendChild(document.createTextNode('.outdated-warning-overlay { position: fixed; top: 0; left: 0; right: 0; box-shadow: 0 0 10px rgba(0, 0, 0, 0.3); z-index: 999; background-color: #ffaba7; color: rgba(0, 0, 0, 0.7); border-bottom: 3px solid #da0b00; padding: 10px 35px; text-align: center; font-size: 15px; } .outdated-warning-overlay .outdated-warning-closer { position: absolute; top: calc(50% - 10px); right: 18px; cursor: pointer; width: 12px; } .outdated-warning-overlay a { color: #2e63b8; } .outdated-warning-overlay a:hover { color: #363636; }'));
head.appendChild(style);

const div = document.createElement('div');
div.classList.add('outdated-warning-overlay');
const closer = document.createElement('div');
closer.classList.add('outdated-warning-closer');

// Icon by font-awesome (license: https://fontawesome.com/license, link: https://fontawesome.com/icons/times?style=solid)
closer.innerHTML = '<svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="times" class="svg-inline--fa fa-times fa-w-11" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 352 512"><path fill="currentColor" d="M242.72 256l100.07-100.07c12.28-12.28 12.28-32.19 0-44.48l-22.24-22.24c-12.28-12.28-32.19-12.28-44.48 0L176 189.28 75.93 89.21c-12.28-12.28-32.19-12.28-44.48 0L9.21 111.45c-12.28 12.28-12.28 32.19 0 44.48L109.28 256 9.21 356.07c-12.28 12.28-12.28 32.19 0 44.48l22.24 22.24c12.28 12.28 32.2 12.28 44.48 0L176 322.72l100.07 100.07c12.28 12.28 32.2 12.28 44.48 0l22.24-22.24c12.28-12.28 12.28-32.19 0-44.48L242.72 256z"></path></svg>';
closer.addEventListener('click', function () {
document.body.removeChild(div);
});
let href = '/stable';
if (window.documenterBaseURL) {
href = window.documenterBaseURL + '/../stable';
}
div.innerHTML = 'This documentation is not for the latest version. <br> <a href="' + href + '">Go to the latest documentation</a>.';
div.appendChild(closer);
document.body.appendChild(div);
};

if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', maybeAddWarning);
} else {
maybeAddWarning();
};
</script></head><body><nav class="toc"><h1>Aqua.jl</h1><select id="version-selector" onchange="window.location.href=this.value" style="visibility: hidden"></select><form action="search/" class="search" id="search-form"><input id="search-query" name="q" placeholder="Search docs" type="text"/></form><ul><li class="current"><a class="toctext" href="">Home</a><ul class="internal"></ul></li></ul></nav><article id="docs"><header><nav><ul><li><a href="">Home</a></li></ul><a class="edit-page" href="https://github.com/tkf/Aqua.jl/blob/master/docs/src/index.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Home</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" href="#Aqua.jl-1" id="Aqua.jl-1">Aqua.jl</a></h1><section class="docstring"><div class="docstring-header"><a class="docstring-binding" href="#Aqua.Aqua" id="Aqua.Aqua"><code>Aqua.Aqua</code></a> — <span class="docstring-category">Module</span>.</div><div><div><p><strong>Aqua.jl: <em>A</em>uto <em>QU</em>ality <em>A</em>ssurance for Julia packages</strong></p><p><a href="https://tkf.github.io/Aqua.jl/stable"><img alt="Stable" src="https://img.shields.io/badge/docs-stable-blue.svg"/></a><a href="https://tkf.github.io/Aqua.jl/dev"><img alt="Dev" src="https://img.shields.io/badge/docs-dev-blue.svg"/></a><a href="https://travis-ci.com/tkf/Aqua.jl"><img alt="Build Status" src="https://travis-ci.com/tkf/Aqua.jl.svg?branch=master"/></a><a href="https://codecov.io/gh/tkf/Aqua.jl"><img alt="Codecov" src="https://codecov.io/gh/tkf/Aqua.jl/branch/master/graph/badge.svg"/></a><a href="https://coveralls.io/github/tkf/Aqua.jl?branch=master"><img alt="Coveralls" src="https://coveralls.io/repos/github/tkf/Aqua.jl/badge.svg?branch=master"/></a><a href="https://github.com/tkf/Aqua.jl"><img alt="Aqua QA" src="https://img.shields.io/badge/Aqua.jl-%F0%9F%8C%A2-aqua.svg"/></a></p><p><strong>Usage</strong></p><p>Call <code>Aqua.test_all(YourPackage)</code> from <code>test/runtests.jl</code>, e.g.,</p><pre><code class="language-julia">using YourPackage
using Aqua
Aqua.test_all(YourPackage)</code></pre></div></div><a class="source-link" target="_blank" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/Aqua.jl#LL1-L20">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Aqua.test_all-Tuple{Module}" href="#Aqua.test_all-Tuple{Module}"><code>Aqua.test_all</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">test_all(testtarget::Module)</code></pre><p>Run following tests in isolated testset:</p><ul><li><a href="#Aqua.test_ambiguities-Tuple{Any}"><code>test_ambiguities</code></a></li><li><a href="#Aqua.test_unbound_args-Tuple{Module}"><code>test_unbound_args</code></a></li><li><a href="#Aqua.test_undefined_exports-Tuple{Module}"><code>test_undefined_exports</code></a></li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/Aqua.jl#LL13-L21">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Aqua.test_ambiguities-Tuple{Any}" href="#Aqua.test_ambiguities-Tuple{Any}"><code>Aqua.test_ambiguities</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">test_ambiguities(package::Module)
test_ambiguities(packages::Vector{Symbol})</code></pre><p>Test that there is no method ambiguities in given package(s). It calls <code>Test.detect_ambiguities</code> in a separated clean process to avoid false-positive.</p></div></div><a class="source-link" target="_blank" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/ambiguities.jl#LL1-L8">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Aqua.test_unbound_args-Tuple{Module}" href="#Aqua.test_unbound_args-Tuple{Module}"><code>Aqua.test_unbound_args</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">test_unbound_args(module::Module)</code></pre><p>Test that all methods in <code>module</code> and its submodules do not have unbound type parameter.</p></div></div><a class="source-link" target="_blank" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/unbound_args.jl#LL1-L6">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="Aqua.test_undefined_exports-Tuple{Module}" href="#Aqua.test_undefined_exports-Tuple{Module}"><code>Aqua.test_undefined_exports</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">test_undefined_exports(module::Module)</code></pre><p>Test that all <code>export</code>ed names in <code>module</code> actually exist.</p></div></div><a class="source-link" target="_blank" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/exports.jl#LL26-L30">source</a></section><footer><hr/><a class="next" href="internals/"><span class="direction">Next</span><span class="title">Internals</span></a></footer></article></body></html>
Aqua.test_all(YourPackage)</code></pre></div></div><a class="source-link" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/Aqua.jl#LL1-L20" target="_blank">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" href="#Aqua.test_all-Tuple{Module}" id="Aqua.test_all-Tuple{Module}"><code>Aqua.test_all</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">test_all(testtarget::Module)</code></pre><p>Run following tests in isolated testset:</p><ul><li><a href="#Aqua.test_ambiguities-Tuple{Any}"><code>test_ambiguities</code></a></li><li><a href="#Aqua.test_unbound_args-Tuple{Module}"><code>test_unbound_args</code></a></li><li><a href="#Aqua.test_undefined_exports-Tuple{Module}"><code>test_undefined_exports</code></a></li></ul></div></div><a class="source-link" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/Aqua.jl#LL13-L21" target="_blank">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" href="#Aqua.test_ambiguities-Tuple{Any}" id="Aqua.test_ambiguities-Tuple{Any}"><code>Aqua.test_ambiguities</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">test_ambiguities(package::Module)
test_ambiguities(packages::Vector{Symbol})</code></pre><p>Test that there is no method ambiguities in given package(s). It calls <code>Test.detect_ambiguities</code> in a separated clean process to avoid false-positive.</p></div></div><a class="source-link" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/ambiguities.jl#LL1-L8" target="_blank">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" href="#Aqua.test_unbound_args-Tuple{Module}" id="Aqua.test_unbound_args-Tuple{Module}"><code>Aqua.test_unbound_args</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">test_unbound_args(module::Module)</code></pre><p>Test that all methods in <code>module</code> and its submodules do not have unbound type parameter.</p></div></div><a class="source-link" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/unbound_args.jl#LL1-L6" target="_blank">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" href="#Aqua.test_undefined_exports-Tuple{Module}" id="Aqua.test_undefined_exports-Tuple{Module}"><code>Aqua.test_undefined_exports</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">test_undefined_exports(module::Module)</code></pre><p>Test that all <code>export</code>ed names in <code>module</code> actually exist.</p></div></div><a class="source-link" href="https://github.com/tkf/Aqua.jl/blob/0bb4baf9e0723b94f6752adf137543d8a0ea6295/src/exports.jl#LL26-L30" target="_blank">source</a></section><footer><hr/><a class="next" href="internals/"><span class="direction">Next</span><span class="title">Internals</span></a></footer></article></body></HTML>
Loading

0 comments on commit 99329c1

Please sign in to comment.