v1.0.1

erdewit · Aug 24, 2023 · 62258ab · 62258ab
1 parent 4c42463
commit 62258ab
Show file tree

Hide file tree

Showing 11 changed files with 134 additions and 133 deletions.
diff --git a/docs/html/_modules/eventkit/event.html b/docs/html/_modules/eventkit/event.html
diff --git a/docs/html/_modules/index.html b/docs/html/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; eventkit 1.0.0 documentation</title>
+  <title>Overview: module code &mdash; eventkit 1.0.1 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
     <link rel="canonical" href="https://eventkit.readthedocs.io_modules/index.html"/>
@@ -54,8 +54,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Overview: module code</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
       <li class="wy-breadcrumbs-aside">
       </li>
   </ul>

diff --git a/docs/html/_static/css/badge_only.css b/docs/html/_static/css/badge_only.css
diff --git a/docs/html/_static/css/theme.css b/docs/html/_static/css/theme.css
diff --git a/docs/html/_static/documentation_options.js b/docs/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.0.0',
+    VERSION: '1.0.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/html/api.html b/docs/html/api.html
@@ -1,10 +1,10 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>eventkit &mdash; eventkit 1.0.0 documentation</title>
+  <title>eventkit &mdash; eventkit 1.0.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
     <link rel="canonical" href="https://eventkit.readthedocs.ioapi.html"/>
@@ -158,8 +158,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>eventkit</li>
+      <li><a href="index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">eventkit</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/api.rst.txt" rel="nofollow"> View page source</a>
       </li>
@@ -171,7 +171,7 @@
 
   <section id="eventkit">
 <span id="api"></span><h1>eventkit<a class="headerlink" href="#eventkit" title="Permalink to this heading"></a></h1>
-<p>Release 1.0.0.</p>
+<p>Release 1.0.1.</p>
 <div class="toctree-wrapper compound">
 </div>
 <section id="event">
@@ -550,7 +550,7 @@ <h2>Event<a class="headerlink" href="#event" title="Permalink to this heading">
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>values</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>) – The source values.</p></li>
 <li><p><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – Time interval in seconds between values.</p></li>
-<li><p><strong>times</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – Relative times for individual values, in seconds since
+<li><p><strong>times</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]]) – Relative times for individual values, in seconds since
 start of event. The sequence should match <code class="docutils literal notranslate"><span class="pre">values</span></code>.</p></li>
 </ul>
 </dd>
@@ -570,7 +570,7 @@ <h2>Event<a class="headerlink" href="#event" title="Permalink to this heading">
 <li><p><strong>value</strong> – The value to emit.</p></li>
 <li><p><strong>count</strong> – Number of times to emit.</p></li>
 <li><p><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – Time interval in seconds between values.</p></li>
-<li><p><strong>times</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – Relative times for individual values, in seconds since
+<li><p><strong>times</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]]) – Relative times for individual values, in seconds since
 start of event. The sequence should match <code class="docutils literal notranslate"><span class="pre">values</span></code>.</p></li>
 </ul>
 </dd>
@@ -589,7 +589,7 @@ <h2>Event<a class="headerlink" href="#event" title="Permalink to this heading">
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>args</strong> – Same as for built-in <code class="docutils literal notranslate"><span class="pre">range</span></code>.</p></li>
 <li><p><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – Time interval in seconds between values.</p></li>
-<li><p><strong>times</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – Relative times for individual values, in seconds since
+<li><p><strong>times</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]]) – Relative times for individual values, in seconds since
 start of event. The sequence should match the range.</p></li>
 </ul>
 </dd>
@@ -641,7 +641,7 @@ <h2>Event<a class="headerlink" href="#event" title="Permalink to this heading">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – Time interval in seconds between emits.</p></li>
-<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Number of times to emit, or <code class="docutils literal notranslate"><span class="pre">None</span></code> for no limit.</p></li>
+<li><p><strong>count</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>]) – Number of times to emit, or <code class="docutils literal notranslate"><span class="pre">None</span></code> for no limit.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
@@ -659,7 +659,7 @@ <h2>Event<a class="headerlink" href="#event" title="Permalink to this heading">
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>s</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The string with characters that are emitted.</p></li>
 <li><p><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – Time interval in seconds between values.</p></li>
-<li><p><strong>times</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – Relative times for individual values, in seconds since
+<li><p><strong>times</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]]) – Relative times for individual values, in seconds since
 start of event. The sequence should match the marble string.</p></li>
 </ul>
 </dd>
@@ -1216,8 +1216,8 @@ <h2>Event<a class="headerlink" href="#event" title="Permalink to this heading">
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>n</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Number of periods.</p></li>
-<li><p><strong>weight</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – Weight of new value.</p></li>
+<li><p><strong>n</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>]) – Number of periods.</p></li>
+<li><p><strong>weight</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – Weight of new value.</p></li>
 </ul>
 </dd>
 </dl>

diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; eventkit 1.0.0 documentation</title>
+  <title>Index &mdash; eventkit 1.0.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
     <link rel="canonical" href="https://eventkit.readthedocs.iogenindex.html"/>
@@ -54,8 +54,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Index</li>
+      <li><a href="index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Index</li>
       <li class="wy-breadcrumbs-aside">
       </li>
   </ul>

diff --git a/docs/html/index.html b/docs/html/index.html
@@ -1,10 +1,10 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Introduction &mdash; eventkit 1.0.0 documentation</title>
+  <title>Introduction &mdash; eventkit 1.0.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
     <link rel="canonical" href="https://eventkit.readthedocs.ioindex.html"/>
@@ -56,8 +56,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
-      <li>Introduction</li>
+      <li><a href="#" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Introduction</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
       </li>
@@ -67,7 +67,7 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <p><a class="reference external" href="https://github.com/erdewit/eventkit/actions"><img alt="Build" src="https://github.com/erdewit/eventkit/actions/workflows/test.yml/badge.svg?branch=master" /></a> <img alt="" src="https://img.shields.io/badge/python-3.6+-blue.svg" /> <img alt="" src="https://img.shields.io/badge/status-beta-green.svg" /> <a class="reference external" href="https://pypi.python.org/pypi/eventkit"><img alt="PyPi" src="https://img.shields.io/pypi/v/eventkit.svg" /></a> <img alt="" src="https://img.shields.io/badge/license-BSD-blue.svg" /> <a class="reference external" href="https://eventkit.readthedocs.io"><img alt="Documentation" src="https://readthedocs.org/projects/eventkit/badge/?version=latest" /></a></p>
+  <p><a class="reference external" href="https://github.com/erdewit/eventkit/actions"><img alt="Build" src="https://github.com/erdewit/eventkit/actions/workflows/test.yml/badge.svg?branch=master" /></a> <img alt="" src="https://img.shields.io/badge/python-3.6+-blue.svg" /> <img alt="" src="https://img.shields.io/badge/status-stable-green.svg" /> <a class="reference external" href="https://pypi.python.org/pypi/eventkit"><img alt="PyPi" src="https://img.shields.io/pypi/v/eventkit.svg" /></a> <img alt="" src="https://img.shields.io/badge/license-BSD-blue.svg" /> <a class="reference external" href="https://eventkit.readthedocs.io"><img alt="Documentation" src="https://readthedocs.org/projects/eventkit/badge/?version=latest" /></a></p>
 <section id="introduction">
 <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this heading"></a></h1>
 <p>The primary use cases of eventkit are</p>