Skip to content

Commit

Permalink
Release 1.2.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@pcisar
pcisar committed Oct 14, 2022
1 parent 8a27b9e commit ea1b45b
Show file tree
Hide file tree
Showing 87 changed files with 8,514 additions and 31,509 deletions.
60 changes: 60 additions & 0 deletions docs/_static/basic.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -641,3 +641,63 @@ dt.field-even:after {
dd.field-list {
grid-column-start: 2;
}

hr.docutils {
font-weight: bold;
/* border: 2px solid #7a9eec; */
border: 2px solid grey;
border-left-style: none;
border-right-style: none;
border-top-style: none;
}

div.versionadded {
color: black;
/* padding: 10px 0 0 10px; */
font-weight: bold;
margin: 5px 0;
}

div.versionchanged {
color: black;
/* padding: 0 10px 0 0; */
font-weight: bold;
margin: 5px 0;
}

span.added {
background: #eeffcc ;
border: 2px solid #aacc99;
border-left-style: none;
border-right-style: none;
padding: 5px;
}

span.changed {
background: #fbe3e4 ;
border: 2px solid #fbc2c4;
border-left-style: none;
border-right-style: none;
padding: 5px;
}

dl.class, dl.exception, dl.data, dl.function {
/* background: #fbe3e4 ;*/
border: 1px solid grey;
border-top-style: none;
border-left-style: none;
border-right-style: none;
/* padding: 3px;*/
}

dt.py {
background: #f8f8f8;
/* border: 2px solid #aacc99;*/
/* border: 2px solid #ffcccc; /*#ffd324;*/
/* border: 2px solid #fbc2c4;*/
border: 1px solid #e1e1e8;
border-top-style: none;
border-left-style: none;
/* border-right-style: none; */
padding: 2px 5px;
}
7 changes: 7 additions & 0 deletions docs/changelog.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
Changelog
#########

Version 1.2.2
=============

* Further code optimizations.
* Addressing issues reported by pylint.
* Improved documentation.

Version 1.2.1
=============

Expand Down
30 changes: 22 additions & 8 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@
author = 'Pavel Císař'

# The short X.Y version
version = '1.2.1'
version = '1.2.2'

# The full version, including alpha/beta/rc tags
release = '1.2.1'
release = '1.2.2'


# -- General configuration ---------------------------------------------------
Expand All @@ -35,11 +35,14 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx_autodoc_typehints',
'sphinx.ext.viewcode',
'sphinx.ext.autosectionlabel',
#'sphinx_autodoc_typehints',
'sphinx.ext.todo',
#'sphinx.ext.coverage',
]

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

# -- Extension configuration -------------------------------------------------

autosectionlabel_prefix_document = True

# Autodoc options
# ---------------
autodoc_default_options = {
'content': 'both',
'members': True,
'member-order': 'bysource',
'member-order': 'groupwise',
'undoc-members': True,
'exclude-members': '__weakref__',
'show-inheritance': True,
'no-inherited-members': True,
'no-private-members': True,
}
autodoc_inherit_docstrings = True
set_type_checking_flag = True
#always_document_param_types = True
autodoc_class_signature = 'mixed'
always_document_param_types = True
autodoc_typehints = 'both' # default 'signature'
autodoc_typehints_format = 'short'
autodoc_typehints_description_target = 'all'

# Napoleon options
# ----------------
Expand All @@ -178,7 +187,12 @@
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = True
napoleon_use_admonition_for_references = True
napoleon_use_ivar = True
napoleon_use_ivar = False
napoleon_use_rtype = True
napoleon_use_param = True
napoleon_use_keyword = True
napoleon_attr_annotations = True
napoleon_preprocess_types = True

# -- Options for intersphinx extension ---------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/firebird-lib.docset/Contents/Resources/Documents/.buildinfo
View file
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: b3e32615185ea05915feca330624737f
config: 5833a633ea9786ec9ba3238b9a1dc38e
tags: 645f666f9bcd5a90fca523b33c5a78b7
181 changes: 181 additions & 0 deletions docs/firebird-lib.docset/Contents/Resources/Documents/_modules/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; firebird-lib 1.2.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js"></script>
<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="../_static/bootstrap-2.3.2/js/bootstrap.min.js"></script>
<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>

</head><body>

<div id="navbar" class="navbar navbar-inverse navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="brand" href="../index.html">
firebird-lib</a>
<span class="navbar-text pull-left"><b>1.2.2</b></span>

<div class="nav-collapse">
<ul class="nav">
<li class="divider-vertical"></li>

<li><a href="../usage-guide.html">Usage Guide</a></li>
<li><a href="../reference.html">Reference</a></li>
<li><a href="../genindex.html">Index</a></li>


<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="../index.html">Content <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usage-guide.html">Usage Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#working-with-database-schema">Working with database schema</a><ul>
<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>
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#metadata-objects">Metadata objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#visitor-pattern-support">Visitor Pattern support</a></li>
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#index-5">Object dependencies</a></li>
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#enhanced-list-of-objects">Enhanced list of objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#sql-operations">SQL operations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#working-with-user-privileges">Working with user privileges</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#working-with-monitoring-tables">Working with monitoring tables</a><ul>
<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>
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#activity-snapshot">Activity snapshot</a></li>
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#i-o-statistics">I/O statistics</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#processing-output-from-gstat-utility">Processing output from gstat utility</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#parsing-gstat-output">Parsing gstat output</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../usage-guide.html#processing-firebird-server-log">Processing Firebird server log</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../usage-guide.html#parsing-the-log">Parsing the log</a></li>
</ul>
</li>
<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>
<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>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../reference.html">Firebird-lib Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../reference.html#package-modules">Package modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../ref-schema.html">firebird.lib.schema</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ref-monitor.html">firebird.lib.monitor</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ref-trace.html">firebird.lib.trace</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ref-gstat.html">firebird.lib.gstat</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ref-log.html">firebird.lib.log</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ref-logmsgs.html">firebird.lib.logmsgs</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-2-2">Version 1.2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-2-1">Version 1.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-2-0">Version 1.2.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-0-1">Version 1.0.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1-0-0">Version 1.0.0</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
</ul>
</ul>
</li>

<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"></ul>
</li>






</ul>



<form class="navbar-form navbar-right" action="../search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>

</div>
</div>
</div>
</div>

<div class="container">
<div class="row">
<div class="body span12 content" role="main">

<h1>All modules for which code is available</h1>
<ul><li><a href="firebird/lib/gstat.html">firebird.lib.gstat</a></li>
<li><a href="firebird/lib/log.html">firebird.lib.log</a></li>
<li><a href="firebird/lib/logmsgs.html">firebird.lib.logmsgs</a></li>
<li><a href="firebird/lib/monitor.html">firebird.lib.monitor</a></li>
<li><a href="firebird/lib/schema.html">firebird.lib.schema</a></li>
<li><a href="firebird/lib/trace.html">firebird.lib.trace</a></li>
</ul>

</div>

</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>

</p>
<p>
&copy; Copyright 2020-2022, The Firebird Project.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.2.3.<br/>
</p>
</div>
</footer>
</body>
</html>
7 changes: 7 additions & 0 deletions docs/firebird-lib.docset/Contents/Resources/Documents/_sources/changelog.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
Changelog
#########

Version 1.2.2
=============

* Further code optimizations.
* Addressing issues reported by pylint.
* Improved documentation.

Version 1.2.1
=============

Expand Down
15 changes: 0 additions & 15 deletions docs/firebird-lib.docset/Contents/Resources/Documents/_sources/ref-gstat.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,20 @@ firebird.lib.gstat
Enums
=====

DbAttribute
-----------
.. autoclass:: DbAttribute
:no-members:

Dataclasses
===========

FillDistribution
----------------
.. autoclass:: FillDistribution
:no-members:

Encryption
----------
.. autoclass:: Encryption
:no-members:

Classes
=======

StatDatabase
------------
.. autoclass:: StatDatabase

StatTable
---------
.. autoclass:: StatTable

StatIndex
---------
.. autoclass:: StatIndex
Loading

0 comments on commit ea1b45b

Please sign in to comment.