Skip to content

Commit ea1b45b

Browse files
pcisarpcisar
committed
Release 1.2.2
1 parent 8a27b9e commit ea1b45b

File tree

87 files changed

+8514
-31509
lines changed

Some content is hidden

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

87 files changed

+8514
-31509
lines changed

‎docs/_static/basic.css‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -641,3 +641,63 @@ dt.field-even:after {
641641
dd.field-list {
642642
grid-column-start: 2;
643643
}
644+
645+
hr.docutils {
646+
font-weight: bold;
647+
/* border: 2px solid #7a9eec; */
648+
border: 2px solid grey;
649+
border-left-style: none;
650+
border-right-style: none;
651+
border-top-style: none;
652+
}
653+
654+
div.versionadded {
655+
color: black;
656+
/* padding: 10px 0 0 10px; */
657+
font-weight: bold;
658+
margin: 5px 0;
659+
}
660+
661+
div.versionchanged {
662+
color: black;
663+
/* padding: 0 10px 0 0; */
664+
font-weight: bold;
665+
margin: 5px 0;
666+
}
667+
668+
span.added {
669+
background: #eeffcc ;
670+
border: 2px solid #aacc99;
671+
border-left-style: none;
672+
border-right-style: none;
673+
padding: 5px;
674+
}
675+
676+
span.changed {
677+
background: #fbe3e4 ;
678+
border: 2px solid #fbc2c4;
679+
border-left-style: none;
680+
border-right-style: none;
681+
padding: 5px;
682+
}
683+
684+
dl.class, dl.exception, dl.data, dl.function {
685+
/* background: #fbe3e4 ;*/
686+
border: 1px solid grey;
687+
border-top-style: none;
688+
border-left-style: none;
689+
border-right-style: none;
690+
/* padding: 3px;*/
691+
}
692+
693+
dt.py {
694+
background: #f8f8f8;
695+
/* border: 2px solid #aacc99;*/
696+
/* border: 2px solid #ffcccc; /*#ffd324;*/
697+
/* border: 2px solid #fbc2c4;*/
698+
border: 1px solid #e1e1e8;
699+
border-top-style: none;
700+
border-left-style: none;
701+
/* border-right-style: none; */
702+
padding: 2px 5px;
703+
}

‎docs/changelog.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22
Changelog
33
#########
44

5+
Version 1.2.2
6+
=============
7+
8+
* Further code optimizations.
9+
* Addressing issues reported by pylint.
10+
* Improved documentation.
11+
512
Version 1.2.1
613
=============
714

‎docs/conf.py‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
author = 'Pavel Císař'
2424

2525
# The short X.Y version
26-
version = '1.2.1'
26+
version = '1.2.2'
2727

2828
# The full version, including alpha/beta/rc tags
29-
release = '1.2.1'
29+
release = '1.2.2'
3030

3131

3232
# -- General configuration ---------------------------------------------------
@@ -35,11 +35,14 @@
3535
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3636
# ones.
3737
extensions = [
38-
'sphinx.ext.autodoc',
3938
'sphinx.ext.intersphinx',
39+
'sphinx.ext.autodoc',
4040
'sphinx.ext.napoleon',
41-
'sphinx_autodoc_typehints',
41+
'sphinx.ext.viewcode',
42+
'sphinx.ext.autosectionlabel',
43+
#'sphinx_autodoc_typehints',
4244
'sphinx.ext.todo',
45+
#'sphinx.ext.coverage',
4346
]
4447

4548
# Add any paths that contain templates here, relative to this directory.
@@ -155,20 +158,26 @@
155158

156159
# -- Extension configuration -------------------------------------------------
157160

161+
autosectionlabel_prefix_document = True
162+
158163
# Autodoc options
159164
# ---------------
160165
autodoc_default_options = {
161166
'content': 'both',
162167
'members': True,
163-
'member-order': 'bysource',
168+
'member-order': 'groupwise',
164169
'undoc-members': True,
165170
'exclude-members': '__weakref__',
166171
'show-inheritance': True,
167172
'no-inherited-members': True,
173+
'no-private-members': True,
168174
}
169-
autodoc_inherit_docstrings = True
170175
set_type_checking_flag = True
171-
#always_document_param_types = True
176+
autodoc_class_signature = 'mixed'
177+
always_document_param_types = True
178+
autodoc_typehints = 'both' # default 'signature'
179+
autodoc_typehints_format = 'short'
180+
autodoc_typehints_description_target = 'all'
172181

173182
# Napoleon options
174183
# ----------------
@@ -178,7 +187,12 @@
178187
napoleon_use_admonition_for_examples = False
179188
napoleon_use_admonition_for_notes = True
180189
napoleon_use_admonition_for_references = True
181-
napoleon_use_ivar = True
190+
napoleon_use_ivar = False
191+
napoleon_use_rtype = True
192+
napoleon_use_param = True
193+
napoleon_use_keyword = True
194+
napoleon_attr_annotations = True
195+
napoleon_preprocess_types = True
182196

183197
# -- Options for intersphinx extension ---------------------------------------
184198

‎docs/firebird-lib.docset/Contents/Resources/Documents/.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: b3e32615185ea05915feca330624737f
3+
config: 5833a633ea9786ec9ba3238b9a1dc38e
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/firebird-lib.docset/Contents/Resources/Documents/_modules/index.html‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
<!DOCTYPE html>
2+
3+
<html lang="en">
4+
<head>
5+
<meta charset="utf-8" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Overview: module code &#8212; firebird-lib 1.2.2 documentation</title>
8+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
9+
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css" />
10+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
11+
<script src="../_static/jquery.js"></script>
12+
<script src="../_static/underscore.js"></script>
13+
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
14+
<script src="../_static/doctools.js"></script>
15+
<script src="../_static/sphinx_highlight.js"></script>
16+
<link rel="index" title="Index" href="../genindex.html" />
17+
<link rel="search" title="Search" href="../search.html" />
18+
<meta charset='utf-8'>
19+
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
20+
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
21+
<meta name="apple-mobile-web-app-capable" content="yes">
22+
<script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js"></script>
23+
<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
24+
<script type="text/javascript" src="../_static/bootstrap-2.3.2/js/bootstrap.min.js"></script>
25+
<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
26+
27+
</head><body>
28+
29+
<div id="navbar" class="navbar navbar-inverse navbar-fixed-top">
30+
<div class="navbar-inner">
31+
<div class="container">
32+
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
33+
<button class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
34+
<span class="icon-bar"></span>
35+
<span class="icon-bar"></span>
36+
<span class="icon-bar"></span>
37+
</button>
38+
39+
<a class="brand" href="../index.html">
40+
firebird-lib</a>
41+
<span class="navbar-text pull-left"><b>1.2.2</b></span>
42+
43+
<div class="nav-collapse">
44+
<ul class="nav">
45+
<li class="divider-vertical"></li>
46+
47+
<li><a href="../usage-guide.html">Usage Guide</a></li>
48+
<li><a href="../reference.html">Reference</a></li>
49+
<li><a href="../genindex.html">Index</a></li>
50+
51+
52+
<li class="dropdown globaltoc-container">
53+
<a role="button"
54+
id="dLabelGlobalToc"
55+
data-toggle="dropdown"
56+
data-target="#"
57+
href="../index.html">Content <b class="caret"></b></a>
58+
<ul class="dropdown-menu globaltoc"
59+
role="menu"
60+
aria-labelledby="dLabelGlobalToc"><p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
61+
<ul>
62+
<li class="toctree-l1"><a class="reference internal" href="../usage-guide.html">Usage Guide</a><ul>
63+
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#working-with-database-schema">Working with database schema</a><ul>
64+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#information-provided-by-schema">Information provided by <code class="xref py py-obj docutils literal notranslate"><span class="pre">Schema</span></code></a></li>
65+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#metadata-objects">Metadata objects</a></li>
66+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#visitor-pattern-support">Visitor Pattern support</a></li>
67+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#index-5">Object dependencies</a></li>
68+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#enhanced-list-of-objects">Enhanced list of objects</a></li>
69+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#sql-operations">SQL operations</a></li>
70+
</ul>
71+
</li>
72+
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#working-with-user-privileges">Working with user privileges</a></li>
73+
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#working-with-monitoring-tables">Working with monitoring tables</a><ul>
74+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#information-provided-by-monitor">Information provided by <code class="xref py py-obj docutils literal notranslate"><span class="pre">Monitor</span></code></a></li>
75+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#activity-snapshot">Activity snapshot</a></li>
76+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#i-o-statistics">I/O statistics</a></li>
77+
</ul>
78+
</li>
79+
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#processing-output-from-gstat-utility">Processing output from gstat utility</a><ul>
80+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#parsing-gstat-output">Parsing gstat output</a></li>
81+
</ul>
82+
</li>
83+
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#processing-firebird-server-log">Processing Firebird server log</a><ul>
84+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#parsing-the-log">Parsing the log</a></li>
85+
</ul>
86+
</li>
87+
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#processing-output-from-firebird-server-trace-sessions">Processing output from Firebird server trace sessions</a><ul>
88+
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#parsing-the-output-from-trace-session">Parsing the output from trace session</a></li>
89+
</ul>
90+
</li>
91+
</ul>
92+
</li>
93+
<li class="toctree-l1"><a class="reference internal" href="../reference.html">Firebird-lib Reference</a><ul>
94+
<li class="toctree-l2"><a class="reference internal" href="../reference.html#package-modules">Package modules</a><ul>
95+
<li class="toctree-l3"><a class="reference internal" href="../ref-schema.html">firebird.lib.schema</a></li>
96+
<li class="toctree-l3"><a class="reference internal" href="../ref-monitor.html">firebird.lib.monitor</a></li>
97+
<li class="toctree-l3"><a class="reference internal" href="../ref-trace.html">firebird.lib.trace</a></li>
98+
<li class="toctree-l3"><a class="reference internal" href="../ref-gstat.html">firebird.lib.gstat</a></li>
99+
<li class="toctree-l3"><a class="reference internal" href="../ref-log.html">firebird.lib.log</a></li>
100+
<li class="toctree-l3"><a class="reference internal" href="../ref-logmsgs.html">firebird.lib.logmsgs</a></li>
101+
</ul>
102+
</li>
103+
</ul>
104+
</li>
105+
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a><ul>
106+
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-2-2">Version 1.2.2</a></li>
107+
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-2-1">Version 1.2.1</a></li>
108+
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-2-0">Version 1.2.0</a></li>
109+
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-0-1">Version 1.0.1</a></li>
110+
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-0-0">Version 1.0.0</a></li>
111+
</ul>
112+
</li>
113+
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
114+
</ul>
115+
</ul>
116+
</li>
117+
118+
<li class="dropdown">
119+
<a role="button"
120+
id="dLabelLocalToc"
121+
data-toggle="dropdown"
122+
data-target="#"
123+
href="#">Page <b class="caret"></b></a>
124+
<ul class="dropdown-menu localtoc"
125+
role="menu"
126+
aria-labelledby="dLabelLocalToc"></ul>
127+
</li>
128+
129+
130+
131+
132+
133+
134+
</ul>
135+
136+
137+
138+
<form class="navbar-form navbar-right" action="../search.html" method="get">
139+
<div class="form-group">
140+
<input type="text" name="q" class="form-control" placeholder="Search" />
141+
</div>
142+
<input type="hidden" name="check_keywords" value="yes" />
143+
<input type="hidden" name="area" value="default" />
144+
</form>
145+
146+
</div>
147+
</div>
148+
</div>
149+
</div>
150+
151+
<div class="container">
152+
<div class="row">
153+
<div class="body span12 content" role="main">
154+
155+
<h1>All modules for which code is available</h1>
156+
<ul><li><a href="firebird/lib/gstat.html">firebird.lib.gstat</a></li>
157+
<li><a href="firebird/lib/log.html">firebird.lib.log</a></li>
158+
<li><a href="firebird/lib/logmsgs.html">firebird.lib.logmsgs</a></li>
159+
<li><a href="firebird/lib/monitor.html">firebird.lib.monitor</a></li>
160+
<li><a href="firebird/lib/schema.html">firebird.lib.schema</a></li>
161+
<li><a href="firebird/lib/trace.html">firebird.lib.trace</a></li>
162+
</ul>
163+
164+
</div>
165+
166+
</div>
167+
</div>
168+
<footer class="footer">
169+
<div class="container">
170+
<p class="pull-right">
171+
<a href="#">Back to top</a>
172+
173+
</p>
174+
<p>
175+
&copy; Copyright 2020-2022, The Firebird Project.<br/>
176+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.2.3.<br/>
177+
</p>
178+
</div>
179+
</footer>
180+
</body>
181+
</html>

‎docs/firebird-lib.docset/Contents/Resources/Documents/_sources/changelog.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22
Changelog
33
#########
44

5+
Version 1.2.2
6+
=============
7+
8+
* Further code optimizations.
9+
* Addressing issues reported by pylint.
10+
* Improved documentation.
11+
512
Version 1.2.1
613
=============
714

‎docs/firebird-lib.docset/Contents/Resources/Documents/_sources/ref-gstat.txt‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,20 @@ firebird.lib.gstat
88
Enums
99
=====
1010

11-
DbAttribute
12-
-----------
1311
.. autoclass:: DbAttribute
14-
:no-members:
1512

1613
Dataclasses
1714
===========
1815

19-
FillDistribution
20-
----------------
2116
.. autoclass:: FillDistribution
2217
:no-members:
2318

24-
Encryption
25-
----------
2619
.. autoclass:: Encryption
2720
:no-members:
2821

2922
Classes
3023
=======
3124

32-
StatDatabase
33-
------------
3425
.. autoclass:: StatDatabase
35-
36-
StatTable
37-
---------
3826
.. autoclass:: StatTable
39-
40-
StatIndex
41-
---------
4227
.. autoclass:: StatIndex

0 commit comments

Comments
 (0)