Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed May 10, 2024
1 parent 79a7de8 commit 2346c26
Show file tree
Hide file tree
Showing 53 changed files with 3,616 additions and 10 deletions.
2 changes: 1 addition & 1 deletion stable/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: b246177a05817d76e13ef316d16578a1
config: 070d6b8965fff7bc50ec795b988f0b9c
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified stable/.doctrees/environment.pickle
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file modified stable/.doctrees/userguides/quickstart.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion stable/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.2">v0.7.2</option>
<option value="v0.7.3">v0.7.3</option>
</select>
</div>
<div role="search">
Expand Down
2 changes: 1 addition & 1 deletion stable/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.2">v0.7.2</option>
<option value="v0.7.3">v0.7.3</option>
</select>
</div>
<div role="search">
Expand Down
2 changes: 1 addition & 1 deletion stable/methoddocs/exceptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.2">v0.7.2</option>
<option value="v0.7.3">v0.7.3</option>
</select>
</div>
<div role="search">
Expand Down
2 changes: 1 addition & 1 deletion stable/methoddocs/providers.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.2">v0.7.2</option>
<option value="v0.7.3">v0.7.3</option>
</select>
</div>
<div role="search">
Expand Down
2 changes: 1 addition & 1 deletion stable/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.2">v0.7.2</option>
<option value="v0.7.3">v0.7.3</option>
</select>
</div>
<div role="search">
Expand Down
2 changes: 1 addition & 1 deletion stable/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.2">v0.7.2</option>
<option value="v0.7.3">v0.7.3</option>
</select>
</div>
<div role="search">
Expand Down
2 changes: 1 addition & 1 deletion stable/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions stable/userguides/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.2">v0.7.2</option>
<option value="v0.7.3">v0.7.3</option>
</select>
</div>
<div role="search">
Expand Down Expand Up @@ -119,7 +119,7 @@ <h1>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to thi
<section id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://www.python.org/downloads">python3</a> version 3.8 up to 3.11.</p></li>
<li><p><a class="reference external" href="https://www.python.org/downloads">python3</a> version 3.8 up to 3.12.</p></li>
</ul>
</section>
<section id="installation">
Expand Down
4 changes: 4 additions & 0 deletions v0.7.3/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 070d6b8965fff7bc50ec795b988f0b9c
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added v0.7.3/.doctrees/environment.pickle
Binary file not shown.
Binary file added v0.7.3/.doctrees/index.doctree
Binary file not shown.
Binary file added v0.7.3/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file added v0.7.3/.doctrees/methoddocs/providers.doctree
Binary file not shown.
Binary file added v0.7.3/.doctrees/userguides/quickstart.doctree
Binary file not shown.
19 changes: 19 additions & 0 deletions v0.7.3/_sources/index.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Ape-Alchemy Documentation

```{eval-rst}
.. toctree::
:caption: User Guides
:maxdepth: 1

userguides/quickstart

```

```{eval-rst}
.. toctree::
:caption: Python Reference
:maxdepth: 1

methoddocs/providers.md
methoddocs/exceptions.md
```
6 changes: 6 additions & 0 deletions v0.7.3/_sources/methoddocs/exceptions.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Exceptions

```{eval-rst}
.. automodule:: ape_alchemy.exceptions
:members:
```
6 changes: 6 additions & 0 deletions v0.7.3/_sources/methoddocs/providers.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Providers

```{eval-rst}
.. automodule:: ape_alchemy.providers
:members:
```
2 changes: 2 additions & 0 deletions v0.7.3/_sources/userguides/quickstart.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../../README.md
```
123 changes: 123 additions & 0 deletions v0.7.3/_static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/

/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;

/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
Loading

0 comments on commit 2346c26

Please sign in to comment.