Skip to content

Commit

Permalink
build based on 1c8f1de
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 20, 2024
1 parent 73e43ea commit 947a75a
Show file tree
Hide file tree
Showing 9 changed files with 155 additions and 23 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-17T23:02:20","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-20T10:19:54","documenter_version":"1.2.1"}}
12 changes: 6 additions & 6 deletions dev/api/axioms/index.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/api/compute/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/api/datasets/index.html

Large diffs are not rendered by default.

132 changes: 132 additions & 0 deletions dev/assets/docs.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
/* mercylessy yannked from ColorSchemes.jl, all credits to them */
/* https://github.com/JuliaGraphics/ColorSchemes.jl/blob/master/docs/src/assets/colorschemes-docs.css */
/* change Bulma Dark styles */

/* disclaimer - I hate CSS */

:root {
--signage: hsl(193, 46%, 60%);
--verydark: hsl(237, 20%, 10%);
--quitedark: hsl(237, 20%, 13%);
--lessdark: hsl(237, 20%, 16%);
}

html.theme--documenter-dark body {
background-color: var(--verydark);
color: #eff;
font-size: 1.1em;
font-weight: 400;
line-height: 1.8rem;
}

html.theme--documenter-dark a {
color: var(--signage);
}

html.theme--documenter-dark p > a:after {
padding-left:0.2rem;
font-family: "JuliaMono";
content: "⮻";
color: var(--signage);
background-color: inherit;
font-size: 120%;
}

html.theme--documenter-light p > a:after {
padding-left:0.2rem;
font-family: "JuliaMono";
content: "⮻";
background-color: inherit;
font-size: 120%;
}

html.theme--documenter-dark .has-text-left,
html.theme--documenter-dark body,
html.theme--documenter-dark #documenter .docs-sidebar,
html.theme--documenter-dark .documenter-example-output,
html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu .tocitem,
html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu .tocitem:hover,
html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu li.is-active .tocitem,
html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu li.is-active .tocitem:hover,
html.theme--documenter-dark #documenter .docs-main header.docs-navbar {
background-color: var(--verydark);
border: 0.5px solid hsla(237, 20%, 10%, 0.3) !important;
}

html.theme--documenter-dark .modal-card-body ,
html.theme--documenter-dark .modal-card-head ,
html.theme--documenter-dark .modal-card-foot ,
html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu ,
html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu li.is-active {
background-color: var(--verydark);
}

html.theme--documenter-dark .docstring ,
html.theme--documenter-dark .docstring>header {
background-color: var(--lessdark);
}

html.theme--documenter-dark .content pre,
html.theme--documenter-dark pre {
background-color: var(--lessdark);
border: 0.5px solid hsla(237, 20%, 10%, 0.3) !important;
}

html.theme--documenter-dark a {
color: var(--signage);
}

html.theme--documenter-dark .modal-card-head {
border: none;
}


.schemename {
font-family: "JuliaMono";
}

.swatch {

}

.category {
font-family: "JuliaMono";
font-size: 0.8em;
}

html.theme--documenter-dark p > code {
color: #eff !important;
}


html.theme--documenter-dark li > code {
color: #eff !important;
}


html.theme--documenter-dark a > code {
color: #eff !important;
}

html.theme--documenter-dark p > a {
color: #eff !important;
}

html.theme--documenter-dark .select select:focus,
html.theme--documenter-dark .textarea:focus,
html.theme--documenter-dark .input:focus,
html.theme--documenter-dark #documenter .docs-sidebar form.docs-search>input:focus,
html.theme--documenter-dark .select select.is-focused,
html.theme--documenter-dark .is-focused.textarea,
html.theme--documenter-dark .is-focused.input,
html.theme--documenter-dark #documenter .docs-sidebar form.docs-search>input.is-focused,
html.theme--documenter-dark .select select:active,
html.theme--documenter-dark .textarea:active,
html.theme--documenter-dark .input:active,
html.theme--documenter-dark #documenter .docs-sidebar form.docs-search>input:active,
html.theme--documenter-dark .select select.is-active,
html.theme--documenter-dark .is-active.textarea,
html.theme--documenter-dark .is-active.input,
html.theme--documenter-dark #documenter .docs-sidebar form.docs-search>input.is-active {
border-color: var(--signage);
}
4 changes: 2 additions & 2 deletions dev/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/tutorials/basic_types/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/tutorials/dataframes/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/tutorials/yaxarrays/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>YAXArrays.jl · SpectralIndices.jl</title><meta name="title" content="YAXArrays.jl · SpectralIndices.jl"/><meta property="og:title" content="YAXArrays.jl · SpectralIndices.jl"/><meta property="twitter:title" content="YAXArrays.jl · SpectralIndices.jl"/><meta name="description" content="Documentation for SpectralIndices.jl."/><meta property="og:description" content="Documentation for SpectralIndices.jl."/><meta property="twitter:description" content="Documentation for SpectralIndices.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="SpectralIndices.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">SpectralIndices.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">SpectralIndices.jl</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../basic_types/">Basics</a></li><li><a class="tocitem" href="../dataframes/">DataFrames.jl</a></li><li class="is-active"><a class="tocitem" href>YAXArrays.jl</a><ul class="internal"><li><a class="tocitem" href="#Computing-Kernels-for-kNDVI"><span>Computing Kernels for kNDVI</span></a></li></ul></li></ul></li><li><span class="tocitem">API Documentation</span><ul><li><a class="tocitem" href="../../api/axioms/">Axioms</a></li><li><a class="tocitem" href="../../api/compute/">Compute</a></li><li><a class="tocitem" href="../../api/datasets/">Datasets</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Tutorials</a></li><li class="is-active"><a href>YAXArrays.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>YAXArrays.jl</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl/blob/main/docs/src/tutorials/yaxarrays.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="YAXArrays.jl"><a class="docs-heading-anchor" href="#YAXArrays.jl">YAXArrays.jl</a><a id="YAXArrays.jl-1"></a><a class="docs-heading-anchor-permalink" href="#YAXArrays.jl" title="Permalink"></a></h1><p>This tutorial will illustrate how to use SpectralIndices.jl using YAXArrays.jl as input data.</p><p>First we need to download the data, like in the previous tutorial. Only this time the data is going to be higher dimensional and slightly more complex, hence the need for YAXArrays.jl. In order to do so we are going to use the <code>load_dataset</code> function:</p><pre><code class="language-julia hljs">using YAXArrays, DimensionalData
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>YAXArrays.jl · SpectralIndices.jl</title><meta name="title" content="YAXArrays.jl · SpectralIndices.jl"/><meta property="og:title" content="YAXArrays.jl · SpectralIndices.jl"/><meta property="twitter:title" content="YAXArrays.jl · SpectralIndices.jl"/><meta name="description" content="Documentation for SpectralIndices.jl."/><meta property="og:description" content="Documentation for SpectralIndices.jl."/><meta property="twitter:description" content="Documentation for SpectralIndices.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script><link href="../../assets/docs.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="SpectralIndices.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">SpectralIndices.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">SpectralIndices.jl</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../basic_types/">Basics</a></li><li><a class="tocitem" href="../dataframes/">DataFrames.jl</a></li><li class="is-active"><a class="tocitem" href>YAXArrays.jl</a><ul class="internal"><li><a class="tocitem" href="#Computing-Kernels-for-kNDVI"><span>Computing Kernels for kNDVI</span></a></li></ul></li></ul></li><li><span class="tocitem">API Documentation</span><ul><li><a class="tocitem" href="../../api/axioms/">Axioms</a></li><li><a class="tocitem" href="../../api/compute/">Compute</a></li><li><a class="tocitem" href="../../api/datasets/">Datasets</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Tutorials</a></li><li class="is-active"><a href>YAXArrays.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>YAXArrays.jl</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl/blob/main/docs/src/tutorials/yaxarrays.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="YAXArrays.jl"><a class="docs-heading-anchor" href="#YAXArrays.jl">YAXArrays.jl</a><a id="YAXArrays.jl-1"></a><a class="docs-heading-anchor-permalink" href="#YAXArrays.jl" title="Permalink"></a></h1><p>This tutorial will illustrate how to use SpectralIndices.jl using YAXArrays.jl as input data.</p><p>First we need to download the data, like in the previous tutorial. Only this time the data is going to be higher dimensional and slightly more complex, hence the need for YAXArrays.jl. In order to do so we are going to use the <code>load_dataset</code> function:</p><pre><code class="language-julia hljs">using YAXArrays, DimensionalData
using SpectralIndices
yaxa = load_dataset(&quot;sentinel&quot;, YAXArray)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">300×300×4 YAXArray{Int64,3}<span class="sgr90"> with dimensions: </span>
<span class="sgr31">Dim{</span><span class="sgr33">:x</span><span class="sgr31">}</span> Sampled{Int64} <span class="sgr36">1:300</span> ForwardOrdered Regular Points,
Expand Down Expand Up @@ -68,4 +68,4 @@
ax = Axis(fig[1, 1])
image!(ax, kndvi.data, colormap=:haline)
ylims!(300, 0)
fig</code></pre><img src="3424b4df.png" alt="Example block output"/></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../dataframes/">« DataFrames.jl</a><a class="docs-footer-nextpage" href="../../api/axioms/">Axioms »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Saturday 17 February 2024 23:02">Saturday 17 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
fig</code></pre><img src="3424b4df.png" alt="Example block output"/></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../dataframes/">« DataFrames.jl</a><a class="docs-footer-nextpage" href="../../api/axioms/">Axioms »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 20 February 2024 10:19">Tuesday 20 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit 947a75a

Please sign in to comment.