Skip to content

Commit

Permalink
Version bump to ship bugfix, update & improve linking in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Cimbali
Cimbali committed Jan 16, 2018
1 parent 5c52a70 commit 99bcbed
Show file tree
Hide file tree
Showing 35 changed files with 2,711 additions and 2,699 deletions.
2 changes: 1 addition & 1 deletion docs/.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: 1aa90593e506b555eb9e0f7a666a4bf2
config: 8020ebe066f0d54b096fd89678222a29
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 deletions docs/README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
<br />
<a href="index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -328,7 +328,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/ctypes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -731,7 +731,7 @@ <h1>Source code for ctypes</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'b&#39;0.6-242-gb240e7c&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
92 changes: 55 additions & 37 deletions docs/_modules/gi/overrides/Gdk.html
View file

Large diffs are not rendered by default.

9 changes: 6 additions & 3 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<br />
<a href="../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -154,14 +154,17 @@
<div itemprop="articleBody">

<h1>All modules for which code is available</h1>
<ul><li><a href="gi/overrides/Gdk.html">gi.overrides.Gdk</a></li>
<ul><li><a href="ctypes.html">ctypes</a></li>
<li><a href="gi/overrides/Gdk.html">gi.overrides.Gdk</a></li>
<li><a href="gi/repository/GdkPixbuf.html">gi.repository.GdkPixbuf</a></li>
<li><a href="gi/repository/Gtk.html">gi.repository.Gtk</a></li>
<li><a href="pympress/builder.html">pympress.builder</a></li>
<li><a href="pympress/callbacks.html">pympress.callbacks</a></li>
<li><a href="pympress/config.html">pympress.config</a></li>
<li><a href="pympress/document.html">pympress.document</a></li>
<li><a href="pympress/editable_label.html">pympress.editable_label</a></li>
<li><a href="pympress/extras.html">pympress.extras</a></li>
<li><a href="pympress/page_number.html">pympress.page_number</a></li>
<li><a href="pympress/pointer.html">pympress.pointer</a></li>
<li><a href="pympress/scribble.html">pympress.scribble</a></li>
<li><a href="pympress/surfacecache.html">pympress.surfacecache</a></li>
Expand Down Expand Up @@ -206,7 +209,7 @@ <h1>All modules for which code is available</h1>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
19 changes: 13 additions & 6 deletions docs/_modules/pympress/builder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -272,10 +272,11 @@ <h1>Source code for pympress.builder</h1><div class="highlight"><pre>

<div class="viewcode-block" id="Builder.find_callback_handler"><a class="viewcode-back" href="../../pympress.html#pympress.builder.Builder.find_callback_handler">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">find_callback_handler</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">handler_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Returns the handler its name. Parse handler names and split on &#39;.&#39; to use some level of recursion.</span>
<span class="sd">&quot;&quot;&quot; Returns the handler from its name, searching in target. Parse handler names and split on &#39;.&#39; to use recursion.</span>

<span class="sd"> Args:</span>
<span class="sd"> handler_name (`str`): The name of the function to be connected to the signal</span>
<span class="sd"> target (`object`): An object that has a method called `handler_name`</span>
<span class="sd"> handler_name (`str`): The name of the function to be connected to a signal</span>

<span class="sd"> Returns:</span>
<span class="sd"> `function`: A function bound to an object or, if the object may change, a lambda calling Builder.signal_resolver to get said function bound to an object</span>
Expand All @@ -298,9 +299,15 @@ <h1>Source code for pympress.builder</h1><div class="highlight"><pre>


<div class="viewcode-block" id="Builder.get_callback_handler"><a class="viewcode-back" href="../../pympress.html#pympress.builder.Builder.get_callback_handler">[docs]</a> <span class="k">def</span> <span class="nf">get_callback_handler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handler_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Convenience non-static wrapper function for :func:`find_callback_handler` to serch in the builder object.</span>
<span class="sd">&quot;&quot;&quot; Convenience non-static wrapper function for :func:`find_callback_handler` to search in the builder object.</span>
<span class="sd"> The `handler_name` function must be a method of this builder (realistically, a method of an inherited UI class&#39; instance).</span>

<span class="sd"> Args:</span>
<span class="sd"> handler_name (`str`): The name of the function to be connected to a signal</span>

<span class="sd"> &quot;&quot;&quot;</span> <span class="o">+</span> <span class="n">Builder</span><span class="o">.</span><span class="n">find_callback_handler</span><span class="o">.</span><span class="vm">__doc__</span>
<span class="sd"> Returns:</span>
<span class="sd"> `function`: A function bound to an object or, if the object may change, a lambda calling Builder.signal_resolver to get said function bound to an object</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_callback_handler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handler_name</span><span class="p">)</span></div>


Expand Down Expand Up @@ -529,7 +536,7 @@ <h1>Source code for pympress.builder</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/callbacks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -282,7 +282,7 @@ <h1>Source code for pympress.callbacks</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-242-gb240e7c&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -551,7 +551,7 @@ <h1>Source code for pympress.config</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/document.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -1020,7 +1020,7 @@ <h1>Source code for pympress.document</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/editable_label.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -600,7 +600,7 @@ <h1>Source code for pympress.editable_label</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/extras.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -465,7 +465,7 @@ <h1>Source code for pympress.extras</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/page_number.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -364,7 +364,7 @@ <h1>Source code for pympress.page_number</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-242-gb240e7c&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/pointer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -366,7 +366,7 @@ <h1>Source code for pympress.pointer</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/scribble.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -571,7 +571,7 @@ <h1>Source code for pympress.scribble</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
11 changes: 5 additions & 6 deletions docs/_modules/pympress/surfacecache.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -234,7 +234,7 @@ <h1>Source code for pympress.surfacecache</h1><div class="highlight"><pre>
<span class="n">surface_cache</span> <span class="o">=</span> <span class="p">{}</span>

<span class="c1">#: `dict` containing functions that return a :class:`~cairo.Surface` given a :class:`~cairo.Context`, width `int` and height `int`</span>
<span class="c1">#: see :func:`~cairo.Surface.create_similar`</span>
<span class="c1">#: see :meth:`~cairo.Surface.create_similar`</span>
<span class="n">surface_factory</span> <span class="o">=</span> <span class="p">{}</span>

<span class="c1">#: Size of the different managed widgets, as a `dict` of tuples</span>
Expand All @@ -247,14 +247,13 @@ <h1>Source code for pympress.surfacecache</h1><div class="highlight"><pre>
<span class="n">surface_type</span> <span class="o">=</span> <span class="p">{}</span>

<span class="c1">#: Dictionary of :class:`~threading.Lock` used for managing conccurent</span>
<span class="c1">#: accesses to :attr:`surface_cache`, :attr:`surface_size`, and :attr:`jobs`.</span>
<span class="c1">#: accesses to :attr:`surface_cache` and :attr:`surface_size`</span>
<span class="n">locks</span> <span class="o">=</span> <span class="p">{}</span>

<span class="c1">#: The current :class:`~pympress.document.Document`.</span>
<span class="n">doc</span> <span class="o">=</span> <span class="kc">None</span>

<span class="c1">#: :class:`~threading.Lock` used to manage conccurent accesses to</span>
<span class="c1">#: :attr:`doc`.</span>
<span class="c1">#: :class:`~threading.Lock` used to manage conccurent accesses to :attr:`doc`.</span>
<span class="n">doc_lock</span> <span class="o">=</span> <span class="kc">None</span>

<span class="c1">#: Set of active widgets</span>
Expand Down Expand Up @@ -510,7 +509,7 @@ <h1>Source code for pympress.surfacecache</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/pympress/talk_time.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -291,7 +291,7 @@ <h1>Source code for pympress.talk_time</h1><div class="highlight"><pre>
<span class="n">position</span> <span class="o">=</span> <span class="p">(</span><span class="n">remaining</span> <span class="o">-</span> <span class="n">prev_time</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">timestamp</span> <span class="o">-</span> <span class="n">prev_time</span><span class="p">)</span>
<span class="n">color_spec</span> <span class="o">=</span> <span class="s1">&#39;* {{color: mix(</span><span class="si">{}</span><span class="s1">, </span><span class="si">{}</span><span class="s1">, </span><span class="si">{}</span><span class="s1">)}}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">prev_color</span><span class="o">.</span><span class="n">to_string</span><span class="p">(),</span> <span class="n">color</span><span class="o">.</span><span class="n">to_string</span><span class="p">(),</span> <span class="n">position</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">color_spec</span> <span class="o">=</span> <span class="s1">&#39;* {color: </span><span class="si">{}</span><span class="s1">}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">color</span><span class="o">.</span><span class="n">to_string</span><span class="p">())</span>
<span class="n">color_spec</span> <span class="o">=</span> <span class="s1">&#39;* {{color: </span><span class="si">{}</span><span class="s1">}}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">color</span><span class="o">.</span><span class="n">to_string</span><span class="p">())</span>

<span class="bp">self</span><span class="o">.</span><span class="n">color_override</span><span class="o">.</span><span class="n">load_from_data</span><span class="p">(</span><span class="n">color_spec</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">&#39;ascii&#39;</span><span class="p">))</span></div></div>

Expand Down Expand Up @@ -455,7 +455,7 @@ <h1>Source code for pympress.talk_time</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/ui.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -1472,7 +1472,7 @@ <h1>Source code for pympress.ui</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pympress/util.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<br />
<a href="../../index.html" class="icon icon-home"> Docs home</a>
<div class="version">
v1.1.0
v1.1.2
</div>


Expand Down Expand Up @@ -459,7 +459,7 @@ <h1>Source code for pympress.util</h1><div class="highlight"><pre>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'b&#39;0.6-250-g2242582&#39;',
VERSION:'b&#39;0.6-254-g5c52a70&#39;',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand Down
Loading

0 comments on commit 99bcbed

Please sign in to comment.