Skip to content

Commit 00487b9

Browse files
jonhealy1jonhealy1
committed
Update documentation [skip ci] 76f4ffa 
0 parents  commit 00487b9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+9467
-0
lines changed

‎.nojekyll‎

Whitespace-only changes.

‎_modules/index.html‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="../">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>Overview: module code &mdash; stac-check 1.7.0 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
10+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
11+
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=7dc6ce7e" />
12+
13+
14+
<script src="../_static/jquery.js?v=5d32c60e"></script>
15+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16+
<script src="../_static/documentation_options.js?v=030dc6f6"></script>
17+
<script src="../_static/doctools.js?v=9a2dae69"></script>
18+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
19+
<script src="../_static/js/theme.js"></script>
20+
<link rel="index" title="Index" href="../genindex.html" />
21+
<link rel="search" title="Search" href="../search.html" />
22+
</head>
23+
24+
<body class="wy-body-for-nav">
25+
<div class="wy-grid-for-nav">
26+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
27+
<div class="wy-side-scroll">
28+
<div class="wy-side-nav-search" >
29+
30+
31+
32+
<a href="../index.html" class="icon icon-home">
33+
stac-check
34+
</a>
35+
<div role="search">
36+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
37+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
38+
<input type="hidden" name="check_keywords" value="yes" />
39+
<input type="hidden" name="area" value="default" />
40+
</form>
41+
</div>
42+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
43+
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
44+
<ul>
45+
<li class="toctree-l1"><a class="reference internal" href="../cli.html">CLI Reference</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="../api.html">API Reference</a></li>
47+
</ul>
48+
49+
</div>
50+
</div>
51+
</nav>
52+
53+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
54+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
55+
<a href="../index.html">stac-check</a>
56+
</nav>
57+
58+
<div class="wy-nav-content">
59+
<div class="rst-content">
60+
<div role="navigation" aria-label="Page navigation">
61+
<ul class="wy-breadcrumbs">
62+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
63+
<li class="breadcrumb-item active">Overview: module code</li>
64+
<li class="wy-breadcrumbs-aside">
65+
</li>
66+
</ul>
67+
<hr/>
68+
</div>
69+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
70+
<div itemprop="articleBody">
71+
72+
<h1>All modules for which code is available</h1>
73+
<ul><li><a href="stac_check/lint.html">stac_check.lint</a></li>
74+
</ul>
75+
76+
</div>
77+
</div>
78+
<footer>
79+
80+
<hr/>
81+
82+
<div role="contentinfo">
83+
<p>&#169; Copyright 2025, Jonathan Healy.</p>
84+
</div>
85+
86+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
87+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
88+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
89+
90+
91+
</footer>
92+
</div>
93+
</div>
94+
</section>
95+
</div>
96+
<script>
97+
jQuery(function () {
98+
SphinxRtdTheme.Navigation.enable(true);
99+
});
100+
</script>
101+
102+
</body>
103+
</html>

‎_modules/stac_check/lint.html‎

Lines changed: 1299 additions & 0 deletions
Large diffs are not rendered by default.

‎_sources/api.rst.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
API Reference
2+
============
3+
4+
.. automodule:: stac_check.lint
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎_sources/cli.rst.txt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
CLI Reference
2+
============
3+
4+
.. automodule:: stac_check.cli
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
.. click:: stac_check.cli:main
10+
:prog: stac-check
11+
:nested: full

‎_sources/index.rst.txt‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
``stac-check`` documentation
2+
############################
3+
4+
.. include:: ../README.md
5+
:parser: myst_parser.sphinx_
6+
:start-after: # stac-check
7+
:end-before: ## License
8+
9+
For more detailed documentation, please see the following pages:
10+
11+
.. toctree::
12+
:maxdepth: 2
13+
:caption: Contents:
14+
15+
cli
16+
api
17+
18+
Indices and tables
19+
=================
20+
21+
* :ref:`genindex`
22+
* :ref:`modindex`
23+
* :ref:`search`

‎_static/_sphinx_javascript_frameworks_compat.js‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
/* Compatability shim for jQuery and underscores.js.
2+
*
3+
* Copyright Sphinx contributors
4+
* Released under the two clause BSD licence
5+
*/
6+
7+
/**
8+
* small helper function to urldecode strings
9+
*
10+
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
11+
*/
12+
jQuery.urldecode = function(x) {
13+
if (!x) {
14+
return x
15+
}
16+
return decodeURIComponent(x.replace(/\+/g, ' '));
17+
};
18+
19+
/**
20+
* small helper function to urlencode strings
21+
*/
22+
jQuery.urlencode = encodeURIComponent;
23+
24+
/**
25+
* This function returns the parsed url parameters of the
26+
* current request. Multiple values per key are supported,
27+
* it will always return arrays of strings for the value parts.
28+
*/
29+
jQuery.getQueryParameters = function(s) {
30+
if (typeof s === 'undefined')
31+
s = document.location.search;
32+
var parts = s.substr(s.indexOf('?') + 1).split('&');
33+
var result = {};
34+
for (var i = 0; i < parts.length; i++) {
35+
var tmp = parts[i].split('=', 2);
36+
var key = jQuery.urldecode(tmp[0]);
37+
var value = jQuery.urldecode(tmp[1]);
38+
if (key in result)
39+
result[key].push(value);
40+
else
41+
result[key] = [value];
42+
}
43+
return result;
44+
};
45+
46+
/**
47+
* highlight a given string on a jquery object by wrapping it in
48+
* span elements with the given class name.
49+
*/
50+
jQuery.fn.highlightText = function(text, className) {
51+
function highlight(node, addItems) {
52+
if (node.nodeType === 3) {
53+
var val = node.nodeValue;
54+
var pos = val.toLowerCase().indexOf(text);
55+
if (pos >= 0 &&
56+
!jQuery(node.parentNode).hasClass(className) &&
57+
!jQuery(node.parentNode).hasClass("nohighlight")) {
58+
var span;
59+
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
60+
if (isInSVG) {
61+
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
62+
} else {
63+
span = document.createElement("span");
64+
span.className = className;
65+
}
66+
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
67+
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
68+
document.createTextNode(val.substr(pos + text.length)),
69+
node.nextSibling));
70+
node.nodeValue = val.substr(0, pos);
71+
if (isInSVG) {
72+
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
73+
var bbox = node.parentElement.getBBox();
74+
rect.x.baseVal.value = bbox.x;
75+
rect.y.baseVal.value = bbox.y;
76+
rect.width.baseVal.value = bbox.width;
77+
rect.height.baseVal.value = bbox.height;
78+
rect.setAttribute('class', className);
79+
addItems.push({
80+
"parent": node.parentNode,
81+
"target": rect});
82+
}
83+
}
84+
}
85+
else if (!jQuery(node).is("button, select, textarea")) {
86+
jQuery.each(node.childNodes, function() {
87+
highlight(this, addItems);
88+
});
89+
}
90+
}
91+
var addItems = [];
92+
var result = this.each(function() {
93+
highlight(this, addItems);
94+
});
95+
for (var i = 0; i < addItems.length; ++i) {
96+
jQuery(addItems[i].parent).before(addItems[i].target);
97+
}
98+
return result;
99+
};
100+
101+
/*
102+
* backward compatibility for jQuery.browser
103+
* This will be supported until firefox bug is fixed.
104+
*/
105+
if (!jQuery.browser) {
106+
jQuery.uaMatch = function(ua) {
107+
ua = ua.toLowerCase();
108+
109+
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
110+
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
111+
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
112+
/(msie) ([\w.]+)/.exec(ua) ||
113+
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
114+
[];
115+
116+
return {
117+
browser: match[ 1 ] || "",
118+
version: match[ 2 ] || "0"
119+
};
120+
};
121+
jQuery.browser = {};
122+
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
123+
}

0 commit comments

Comments
 (0)