Actions: Build documentation

giocaizzi · Jan 1, 2024 · ec6a277 · ec6a277
1 parent 86eb8f6
commit ec6a277
Show file tree

Hide file tree

Showing 53 changed files with 14,528 additions and 1,269 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -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: 6a260dd8bd93bdc2b3b1b290a235d4ef
+config: 93e8f1a576d00976af8a5874bdb88fa5
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_autosummary/pysurfline.api.client.SurflineClient.html b/docs/_autosummary/pysurfline.api.client.SurflineClient.html
@@ -1,8 +1,7 @@
 <!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="viewport" content="width=device-width, initial-scale=1.0" />
   <title>pysurfline.api.client.SurflineClient &mdash; pysurfline 0.2.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -11,11 +10,10 @@
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../_static/jquery.js?v=5d32c60e"></script>
-        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=938c9ccc"></script>
-        <script src="../_static/doctools.js?v=888ff710"></script>
-        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+        <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/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -48,8 +46,9 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../examples/SpotForecasts.html">Get surf forecasts for a Surfline spot</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/SpotForecasts.html">Surf forecasts for a Surfline spot</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples/SurfReport.html">Visualize the surf report</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/SurflineAPI.html">Surfline API</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Code reference</span></p>
 <ul class="current">
@@ -99,18 +98,22 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="pysurfline-api-client-surflineclient">
-<h1>pysurfline.api.client.SurflineClient<a class="headerlink" href="#pysurfline-api-client-surflineclient" title="Link to this heading"></a></h1>
+  <div class="section" id="pysurfline-api-client-surflineclient">
+<h1>pysurfline.api.client.SurflineClient<a class="headerlink" href="#pysurfline-api-client-surflineclient" title="Permalink to this headline"></a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="pysurfline.api.client.SurflineClient">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pysurfline.api.client.</span></span><span class="sig-name descname"><span class="pre">SurflineClient</span></span><a class="headerlink" href="#pysurfline.api.client.SurflineClient" title="Link to this definition"></a></dt>
+<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">pysurfline.api.client.</span></span><span class="sig-name descname"><span class="pre">SurflineClient</span></span><a class="headerlink" href="#pysurfline.api.client.SurflineClient" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>surfline client</p>
 <p>Surfline API client.
 At the moment, does not require authentication.</p>
 <p>TODO: Login and authentication</p>
 <p class="rubric">Methods</p>
-<table class="autosummary longtable docutils align-default">
+<table class="longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
 <tbody>
 <tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code>()</p></td>
 <td><p></p></td>
@@ -122,28 +125,28 @@ <h1>pysurfline.api.client.SurflineClient<a class="headerlink" href="#pysurfline-
 </table>
 <dl class="py method">
 <dt class="sig sig-object py" id="pysurfline.api.client.SurflineClient.get_spot_forecasts">
-<span class="sig-name descname"><span class="pre">get_spot_forecasts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spotId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intervalHours</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">days</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="pysurfline.core.SpotForecasts.html#pysurfline.core.SpotForecasts" title="pysurfline.core.SpotForecasts"><span class="pre">SpotForecasts</span></a></span></span><a class="headerlink" href="#pysurfline.api.client.SurflineClient.get_spot_forecasts" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">get_spot_forecasts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spotId</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intervalHours</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">days</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="pysurfline.core.SpotForecasts.html#pysurfline.core.SpotForecasts" title="pysurfline.core.SpotForecasts"><span class="pre">pysurfline.core.SpotForecasts</span></a></span></span><a class="headerlink" href="#pysurfline.api.client.SurflineClient.get_spot_forecasts" title="Permalink to this definition"></a></dt>
 <dd><p>create a SpotForecast object from API responses</p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>spotId</strong> (<em>str</em>) – spot id</p></li>
 <li><p><strong>intervalHours</strong> (<em>int</em><em>, </em><em>optional</em>) – interval hours. Defaults to None.</p></li>
 <li><p><strong>days</strong> (<em>int</em><em>, </em><em>optional</em>) – days. Defaults to None.</p></li>
 </ul>
 </dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dt class="field-even">Returns</dt>
 <dd class="field-even"><p>SpotForecast object</p>
 </dd>
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dt class="field-odd">Return type</dt>
 <dd class="field-odd"><p>SpotForecast</p>
 </dd>
 </dl>
 </dd></dl>
 
 </dd></dl>
 
-</section>
+</div>
 
 
            </div>

diff --git a/docs/_autosummary/pysurfline.api.client.html b/docs/_autosummary/pysurfline.api.client.html
@@ -1,8 +1,7 @@
 <!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="viewport" content="width=device-width, initial-scale=1.0" />
   <title>pysurfline.api.client &mdash; pysurfline 0.2.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -11,11 +10,10 @@
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../_static/jquery.js?v=5d32c60e"></script>
-        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=938c9ccc"></script>
-        <script src="../_static/doctools.js?v=888ff710"></script>
-        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+        <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/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -48,8 +46,9 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../examples/SpotForecasts.html">Get surf forecasts for a Surfline spot</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/SpotForecasts.html">Surf forecasts for a Surfline spot</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples/SurfReport.html">Visualize the surf report</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/SurflineAPI.html">Surfline API</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Code reference</span></p>
 <ul class="current">
@@ -98,17 +97,21 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="module-pysurfline.api.client">
-<span id="pysurfline-api-client"></span><h1>pysurfline.api.client<a class="headerlink" href="#module-pysurfline.api.client" title="Link to this heading"></a></h1>
+  <div class="section" id="module-pysurfline.api.client">
+<span id="pysurfline-api-client"></span><h1>pysurfline.api.client<a class="headerlink" href="#module-pysurfline.api.client" title="Permalink to this headline"></a></h1>
 <p class="rubric">Classes</p>
-<table class="autosummary longtable docutils align-default">
+<table class="longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="pysurfline.api.client.SurflineClient.html#pysurfline.api.client.SurflineClient" title="pysurfline.api.client.SurflineClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SurflineClient</span></code></a>()</p></td>
 <td><p>surfline client</p></td>
 </tr>
 </tbody>
 </table>
-</section>
+</div>
 
 
            </div>

diff --git a/docs/_autosummary/pysurfline.api.html b/docs/_autosummary/pysurfline.api.html
@@ -1,8 +1,7 @@
 <!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="viewport" content="width=device-width, initial-scale=1.0" />
   <title>pysurfline.api &mdash; pysurfline 0.2.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -11,11 +10,10 @@
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../_static/jquery.js?v=5d32c60e"></script>
-        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=938c9ccc"></script>
-        <script src="../_static/doctools.js?v=888ff710"></script>
-        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+        <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/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -48,8 +46,9 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../examples/SpotForecasts.html">Get surf forecasts for a Surfline spot</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/SpotForecasts.html">Surf forecasts for a Surfline spot</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples/SurfReport.html">Visualize the surf report</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/SurflineAPI.html">Surfline API</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Code reference</span></p>
 <ul class="current">
@@ -94,10 +93,14 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="module-pysurfline.api">
-<span id="pysurfline-api"></span><h1>pysurfline.api<a class="headerlink" href="#module-pysurfline.api" title="Link to this heading"></a></h1>
+  <div class="section" id="module-pysurfline.api">
+<span id="pysurfline-api"></span><h1>pysurfline.api<a class="headerlink" href="#module-pysurfline.api" title="Permalink to this headline"></a></h1>
 <p class="rubric">Modules</p>
-<table class="autosummary longtable docutils align-default">
+<table class="longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="pysurfline.api.client.html#module-pysurfline.api.client" title="pysurfline.api.client"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pysurfline.api.client</span></code></a></p></td>
 <td><p></p></td>
@@ -116,7 +119,7 @@
 </tr>
 </tbody>
 </table>
-</section>
+</div>
 
 
            </div>

diff --git a/docs/_autosummary/pysurfline.api.models.html b/docs/_autosummary/pysurfline.api.models.html
@@ -1,8 +1,7 @@
 <!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="viewport" content="width=device-width, initial-scale=1.0" />
   <title>pysurfline.api.models &mdash; pysurfline 0.2.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -11,11 +10,10 @@
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../_static/jquery.js?v=5d32c60e"></script>
-        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=938c9ccc"></script>
-        <script src="../_static/doctools.js?v=888ff710"></script>
-        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+        <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/doctools.js"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -48,8 +46,9 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Examples</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../examples/SpotForecasts.html">Get surf forecasts for a Surfline spot</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/SpotForecasts.html">Surf forecasts for a Surfline spot</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples/SurfReport.html">Visualize the surf report</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/SurflineAPI.html">Surfline API</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Code reference</span></p>
 <ul class="current">
@@ -98,17 +97,21 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="module-pysurfline.api.models">
-<span id="pysurfline-api-models"></span><h1>pysurfline.api.models<a class="headerlink" href="#module-pysurfline.api.models" title="Link to this heading"></a></h1>
+  <div class="section" id="module-pysurfline.api.models">
+<span id="pysurfline-api-models"></span><h1>pysurfline.api.models<a class="headerlink" href="#module-pysurfline.api.models" title="Permalink to this headline"></a></h1>
 <p class="rubric">Modules</p>
-<table class="autosummary longtable docutils align-default">
+<table class="longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="pysurfline.api.models.spots.html#module-pysurfline.api.models.spots" title="pysurfline.api.models.spots"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pysurfline.api.models.spots</span></code></a></p></td>
 <td><p>api objects: data models</p></td>
 </tr>
 </tbody>
 </table>
-</section>
+</div>
 
 
            </div>