Skip to content

Commit 496ee64

Browse files
JamieTaylor-TUOSJamieTaylor-TUOS
committed
Update API reference docs
1 parent 6432348 commit 496ee64

53 files changed

Lines changed: 12342 additions & 1077 deletions

Some content is hidden

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

‎dbconnector/dbconnector.py‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -442,13 +442,11 @@ def query(self, sqlquery: str, df: bool = False):
442442
443443
Returns
444444
-------
445-
list *OR* Pandas DataFrame
445+
List or Pandas DataFrame
446446
If `df=False`, returns a list of tuples, [(R1C1, R1C2, ...), (R2C1, R2C2, ...), ...].
447447
Length of list corresponds to N rows returned, length of tuples corresponds to columns
448-
selected.
449-
450-
If `df=True`, returns a Pandas DataFrame containing the columns from the `sqlquery` and
451-
any rows returned.
448+
selected. If `df=True`, returns a Pandas DataFrame containing the columns from the
449+
`sqlquery` and any rows returned.
452450
"""
453451
return self._safe_query(self._select_query, sqlquery=sqlquery, df=df)
454452

@@ -465,8 +463,9 @@ def proc(self, proc: str, proc_args: List):
465463
466464
Returns
467465
-------
468-
list
469-
A list of stored results, see `here <https://dev.mysql.com/doc/connector-python/en/connector-python-api-mysqlcursor-stored-results.html>`_.
466+
List
467+
A list of stored results, see
468+
https://dev.mysql.com/doc/connector-python/en/connector-python-api-mysqlcursor-stored-results.html
470469
"""
471470
return self._safe_query(self._proc_query, proc=proc, proc_args=proc_args)
472471

‎docs/build/doctrees/environment.pickle‎

5.42 KB
Binary file not shown.

‎docs/build/doctrees/index.doctree‎

54 Bytes
Binary file not shown.

‎docs/build/doctrees/modules.doctree‎

-1.79 KB
Binary file not shown.

‎docs/build/html/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 47f3a99322ff9a118649619218d91df2
3+
config: 77e1dbbb3e856ac69978307fdd351543
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/_modules/dbconnector/dbconnector.html‎

Lines changed: 114 additions & 97 deletions
Large diffs are not rendered by default.

‎docs/build/html/_modules/index.html‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en" data-content_root="../">
35
<head>
46
<meta charset="utf-8" />
57
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Overview: module code &mdash; MySQL-DBConnector 1.3.4 documentation</title>
7-
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
8-
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
9-
<!--[if lt IE 9]>
10-
<script src="../_static/js/html5shiv.min.js"></script>
11-
<![endif]-->
8+
<title>Overview: module code &mdash; MySQL-DBConnector 1.4.0 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
10+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
11+
1212

13-
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
14-
<script src="../_static/jquery.js"></script>
15-
<script src="../_static/underscore.js"></script>
16-
<script src="../_static/doctools.js"></script>
13+
<script src="../_static/jquery.js?v=5d32c60e"></script>
14+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15+
<script src="../_static/documentation_options.js?v=9172181d"></script>
16+
<script src="../_static/doctools.js?v=9a2dae69"></script>
17+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1718
<script src="../_static/js/theme.js"></script>
1819
<link rel="index" title="Index" href="../genindex.html" />
1920
<link rel="search" title="Search" href="../search.html" />
@@ -24,14 +25,15 @@
2425
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2526
<div class="wy-side-scroll">
2627
<div class="wy-side-nav-search" >
27-
<a href="../index.html" class="icon icon-home"> MySQL-DBConnector
28+
29+
30+
31+
<a href="../index.html" class="icon icon-home">
32+
MySQL-DBConnector
2833
</a>
29-
<div class="version">
30-
1.3
31-
</div>
3234
<div role="search">
3335
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
34-
<input type="text" name="q" placeholder="Search docs" />
36+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
3537
<input type="hidden" name="check_keywords" value="yes" />
3638
<input type="hidden" name="area" value="default" />
3739
</form>
@@ -56,8 +58,8 @@
5658
<div class="rst-content">
5759
<div role="navigation" aria-label="Page navigation">
5860
<ul class="wy-breadcrumbs">
59-
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
60-
<li>Overview: module code</li>
61+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
62+
<li class="breadcrumb-item active">Overview: module code</li>
6163
<li class="wy-breadcrumbs-aside">
6264
</li>
6365
</ul>

‎docs/build/html/_sources/modules.rst.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Modules
33

44

55
.. contents:: Contents
6-
:depth: 2
6+
:depth: 3
77

88

99
dbconnector

‎docs/build/html/_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+
}

‎docs/build/html/_static/basic.css‎

Lines changed: 46 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -222,7 +222,7 @@ table.modindextable td {
222222
/* -- general body styles --------------------------------------------------- */
223223

224224
div.body {
225-
min-width: 450px;
225+
min-width: 360px;
226226
max-width: 800px;
227227
}
228228

@@ -237,14 +237,8 @@ a.headerlink {
237237
visibility: hidden;
238238
}
239239

240-
a.brackets:before,
241-
span.brackets > a:before{
242-
content: "[";
243-
}
244-
245-
a.brackets:after,
246-
span.brackets > a:after {
247-
content: "]";
240+
a:visited {
241+
color: #551A8B;
248242
}
249243

250244
h1:hover > a.headerlink,
@@ -335,12 +329,16 @@ p.sidebar-title {
335329
font-weight: bold;
336330
}
337331

332+
nav.contents,
333+
aside.topic,
338334
div.admonition, div.topic, blockquote {
339335
clear: left;
340336
}
341337

342338
/* -- topics ---------------------------------------------------------------- */
343339

340+
nav.contents,
341+
aside.topic,
344342
div.topic {
345343
border: 1px solid #ccc;
346344
padding: 7px;
@@ -379,13 +377,17 @@ div.body p.centered {
379377

380378
div.sidebar > :last-child,
381379
aside.sidebar > :last-child,
380+
nav.contents > :last-child,
381+
aside.topic > :last-child,
382382
div.topic > :last-child,
383383
div.admonition > :last-child {
384384
margin-bottom: 0;
385385
}
386386

387387
div.sidebar::after,
388388
aside.sidebar::after,
389+
nav.contents::after,
390+
aside.topic::after,
389391
div.topic::after,
390392
div.admonition::after,
391393
blockquote::after {
@@ -428,10 +430,6 @@ table.docutils td, table.docutils th {
428430
border-bottom: 1px solid #aaa;
429431
}
430432

431-
table.footnote td, table.footnote th {
432-
border: 0 !important;
433-
}
434-
435433
th {
436434
text-align: left;
437435
padding-right: 5px;
@@ -615,19 +613,26 @@ ul.simple p {
615613
margin-bottom: 0;
616614
}
617615

618-
dl.footnote > dt,
619-
dl.citation > dt {
616+
aside.footnote > span,
617+
div.citation > span {
620618
float: left;
621-
margin-right: 0.5em;
622619
}
623-
624-
dl.footnote > dd,
625-
dl.citation > dd {
620+
aside.footnote > span:last-of-type,
621+
div.citation > span:last-of-type {
622+
padding-right: 0.5em;
623+
}
624+
aside.footnote > p {
625+
margin-left: 2em;
626+
}
627+
div.citation > p {
628+
margin-left: 4em;
629+
}
630+
aside.footnote > p:last-of-type,
631+
div.citation > p:last-of-type {
626632
margin-bottom: 0em;
627633
}
628-
629-
dl.footnote > dd:after,
630-
dl.citation > dd:after {
634+
aside.footnote > p:last-of-type:after,
635+
div.citation > p:last-of-type:after {
631636
content: "";
632637
clear: both;
633638
}
@@ -644,10 +649,6 @@ dl.field-list > dt {
644649
padding-right: 5px;
645650
}
646651

647-
dl.field-list > dt:after {
648-
content: ":";
649-
}
650-
651652
dl.field-list > dd {
652653
padding-left: 0.5em;
653654
margin-top: 0em;
@@ -673,6 +674,16 @@ dd {
673674
margin-left: 30px;
674675
}
675676

677+
.sig dd {
678+
margin-top: 0px;
679+
margin-bottom: 0px;
680+
}
681+
682+
.sig dl {
683+
margin-top: 0px;
684+
margin-bottom: 0px;
685+
}
686+
676687
dl > dd:last-child,
677688
dl > dd:last-child > :last-child {
678689
margin-bottom: 0;
@@ -741,6 +752,14 @@ abbr, acronym {
741752
cursor: help;
742753
}
743754

755+
.translated {
756+
background-color: rgba(207, 255, 207, 0.2)
757+
}
758+
759+
.untranslated {
760+
background-color: rgba(255, 207, 207, 0.2)
761+
}
762+
744763
/* -- code displays --------------------------------------------------------- */
745764

746765
pre {

0 commit comments

Comments
 (0)