docs HTML generated and data transformed

168a1a5c · safer-lgtm · ab308de7 · 168a1a5c · 168a1a5c · 168a1a5c
Commit 168a1a5c authored 10 months ago by safer-lgtm
--- a/.gitignore
+++ b/.gitignore
@@ -62,6 +62,7 @@ instance/

 # Sphinx documentation
 docs/_build/
+docs/generated/

 # PyBuilder
 target/
@@ -94,6 +95,7 @@ ENV/

 # My Data
 /Data
+/Data/*

 # Vs code Setting
 .vscode/
@@ -103,3 +105,5 @@ ENV/

 # Ignore config file with sensitive information
 config.ini
+
+.DS_Store
\ No newline at end of file
--- a/docs/API.rst
+++ b/docs/API.rst
@@ -4,4 +4,4 @@ API
 .. autosummary::
   :toctree: generated

-   formulaone.helpers
\ No newline at end of file
+   dynamodb.dynamodb_helpers
\ No newline at end of file
--- a/docs/docHTMLs/.buildinfo
+++ b/docs/docHTMLs/.buildinfo
+# 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: 192e42e872864313c12dcb7e3a4cfed8
+tags: 645f666f9bcd5a90fca523b33c5a78b7
--- a/docs/docHTMLs/.doctrees/API.doctree
+++ b/docs/docHTMLs/.doctrees/API.doctree
--- a/docs/docHTMLs/.doctrees/dynamodb.doctree
+++ b/docs/docHTMLs/.doctrees/dynamodb.doctree
--- a/docs/docHTMLs/.doctrees/environment.pickle
+++ b/docs/docHTMLs/.doctrees/environment.pickle
--- a/docs/docHTMLs/.doctrees/generated/dynamodb.dynamodb_helpers.doctree
+++ b/docs/docHTMLs/.doctrees/generated/dynamodb.dynamodb_helpers.doctree
--- a/docs/docHTMLs/.doctrees/generated/ergast.doctree
+++ b/docs/docHTMLs/.doctrees/generated/ergast.doctree
--- a/docs/docHTMLs/.doctrees/generated/sample.doctree
+++ b/docs/docHTMLs/.doctrees/generated/sample.doctree
--- a/docs/docHTMLs/.doctrees/generated/sample.helpers.doctree
+++ b/docs/docHTMLs/.doctrees/generated/sample.helpers.doctree
--- a/docs/docHTMLs/.doctrees/index.doctree
+++ b/docs/docHTMLs/.doctrees/index.doctree
--- a/docs/docHTMLs/.doctrees/modules.doctree
+++ b/docs/docHTMLs/.doctrees/modules.doctree
--- a/docs/docHTMLs/.doctrees/usage.doctree
+++ b/docs/docHTMLs/.doctrees/usage.doctree
--- a/docs/docHTMLs/API.html
+++ b/docs/docHTMLs/API.html
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>API &#8212; sample v0.0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="_static/classic.css?v=def86cc0" />
+    
+    <script src="_static/documentation_options.js?v=2fea6348"></script>
+    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="dynamodb.dynamodb_helpers" href="generated/dynamodb.dynamodb_helpers.html" />
+    <link rel="prev" title="Usage" href="usage.html" /> 
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="generated/dynamodb.dynamodb_helpers.html" title="dynamodb.dynamodb_helpers"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="usage.html" title="Usage"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">API</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <section id="api">
+<h1>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h1>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/dynamodb.dynamodb_helpers.html#module-dynamodb.dynamodb_helpers" title="dynamodb.dynamodb_helpers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers</span></code></a></p></td>
+<td><p></p></td>
+</tr>
+</tbody>
+</table>
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="usage.html"
+                          title="previous chapter">Usage</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="generated/dynamodb.dynamodb_helpers.html"
+                          title="next chapter">dynamodb.dynamodb_helpers</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/API.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<search id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="generated/dynamodb.dynamodb_helpers.html" title="dynamodb.dynamodb_helpers"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="usage.html" title="Usage"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">API</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2012, Kenneth Reitz.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
+    </div>
+  </body>
+</html>
\ No newline at end of file
--- a/docs/docHTMLs/_sources/API.rst.txt
+++ b/docs/docHTMLs/_sources/API.rst.txt
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+   dynamodb.dynamodb_helpers
\ No newline at end of file
--- a/docs/formulaone.rst
+++ b/docs/formulaone.rst
-formulaone package
-==================
+dynamodb package
+================

 Submodules
 ----------

-formulaone.core module
----------------------
+dynamodb.core module
+--------------------

-.. automodule:: formulaone.core
+.. automodule:: dynamodb.core
   :members:
   :undoc-members:
   :show-inheritance:

-formulaone.dynamodb\_helpers module
-----------------------------------
+dynamodb.dynamodb\_helpers module
+---------------------------------

-.. automodule:: formulaone.dynamodb_helpers
+.. automodule:: dynamodb.dynamodb_helpers
   :members:
   :undoc-members:
   :show-inheritance:

-formulaone.helpers module
-------------------------
-
-.. automodule:: formulaone.helpers
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-formulaone.load\_latest\_race module
------------------------------------
+dynamodb.load\_movies module
+----------------------------

-.. automodule:: formulaone.load_latest_race
+.. automodule:: dynamodb.load_movies
   :members:
   :undoc-members:
   :show-inheritance:

-formulaone.prepare\_data module
-------------------------------
+dynamodb.prepare\_data module
+-----------------------------

-.. automodule:: formulaone.prepare_data
+.. automodule:: dynamodb.prepare_data
   :members:
   :undoc-members:
   :show-inheritance:

-formulaone.tidy\_data module
----------------------------
+dynamodb.tidy\_data module
+--------------------------

-.. automodule:: formulaone.tidy_data
+.. automodule:: dynamodb.tidy_data
   :members:
   :undoc-members:
   :show-inheritance:
@@ -55,7 +47,7 @@ formulaone.tidy\_data module
 Module contents
 ---------------

-.. automodule:: formulaone
+.. automodule:: dynamodb
   :members:
   :undoc-members:
   :show-inheritance:
--- a/docs/docHTMLs/_sources/generated/dynamodb.dynamodb_helpers.rst.txt
+++ b/docs/docHTMLs/_sources/generated/dynamodb.dynamodb_helpers.rst.txt
+dynamodb.dynamodb\_helpers
+==========================
+
+.. automodule:: dynamodb.dynamodb_helpers
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      get_config
+      get_dynamodb_resource
+      get_movie_item
+      get_movies_table
+      get_path_to_data
+      get_raw_data_path
+      get_tidy_data_path
+      list_dynamodb_tables
+      query_movies_by_year
+      tidy_movie_data
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+
--- a/docs/docHTMLs/_sources/generated/ergast.rst.txt
+++ b/docs/docHTMLs/_sources/generated/ergast.rst.txt
+.. _ergast:
+
+Ergast API Interface
+====================
+
+.. currentmodule::
+  fastf1.ergast
+
+Introduction
+------------
+
+This module can be used to interface with the Ergast F1 API
+(https://ergast.com/mrd/). All Ergast endpoints are supported.
+
+The :class:`Ergast` object provides access to all API Endpoints of the
+Ergast API.
+
+The terms of use of Ergast apply (https://ergast.com/mrd/terms/).
+Especially take care not to exceed the specified rate limits.
+FastF1 will handle caching and it will try to enforce rate limits where
+possible. Make sure to know what limits apply. For more information on how
+FastF1 handles caching and rate limiting see :ref:`requests-and-caching`.
--- a/docs/docHTMLs/_sources/generated/sample.helpers.rst.txt
+++ b/docs/docHTMLs/_sources/generated/sample.helpers.rst.txt
+sample.helpers
+==============
+
+.. automodule:: sample.helpers
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      get_path_to_data
+      get_raw_data_path
+      get_tidy_data_path
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+
--- a/docs/docHTMLs/_sources/generated/sample.rst.txt
+++ b/docs/docHTMLs/_sources/generated/sample.rst.txt
+sample
+======
+
+.. automodule:: sample
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+