Alexander/FitTrackee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Sam
2021-04-06 14:03:42 +02:00
parent afb302a047
commit 162499fd04
23 changed files with 287 additions and 262 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/api/auth.html
View File

@ -3,7 +3,8 @@
<html>
<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.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>Authentication &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -124,7 +125,7 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="authentication">
<section id="authentication">
<h1>Authentication<a class="headerlink" href="#authentication" title="Permalink to this headline"></a></h1>
<dl class="http post">
<dt id="post--api-auth-register">
@ -602,7 +603,7 @@
</dl>
</dd></dl>
</div>
</section>
</div>
@ -616,8 +617,8 @@
</p>
<p>
&copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.1.<br/>
&copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.3.<br/>
</p>
</div>
</footer>

11
docs/api/configuration.html
View File

@ -3,7 +3,8 @@
<html>
<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.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>Configuration &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -124,7 +125,7 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="configuration">
<section id="configuration">
<h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
<dl class="http get">
<dt id="get--api-config">
@ -253,7 +254,7 @@
</dl>
</dd></dl>
</div>
</section>
</div>
@ -267,8 +268,8 @@
</p>
<p>
&copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.1.<br/>
&copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.3.<br/>
</p>
</div>
</footer>

13
docs/api/index.html
View File

@ -3,7 +3,8 @@
<html>
<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.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>API documentation &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -124,10 +125,10 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="api-documentation">
<section id="api-documentation">
<h1>API documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Endpoints:</span></p>
<p><span class="caption-text">Endpoints:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="auth.html">Authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
@ -138,7 +139,7 @@
<li class="toctree-l1"><a class="reference internal" href="workouts.html">Workouts</a></li>
</ul>
</div>
</div>
</section>
</div>
@ -152,8 +153,8 @@
</p>
<p>
&copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.1.<br/>
&copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.3.<br/>
</p>
</div>
</footer>

11
docs/api/records.html
View File

@ -3,7 +3,8 @@
<html>
<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.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>Records &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -124,7 +125,7 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="records">
<section id="records">
<h1>Records<a class="headerlink" href="#records" title="Permalink to this headline"></a></h1>
<dl class="http get">
<dt id="get--api-records">
@ -235,7 +236,7 @@
</dl>
</dd></dl>
</div>
</section>
</div>
@ -249,8 +250,8 @@
</p>
<p>
&copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.1.<br/>
&copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.3.<br/>
</p>
</div>
</footer>

11
docs/api/sports.html
View File

@ -3,7 +3,8 @@
<html>
<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.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>Sports &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -124,7 +125,7 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="sports">
<section id="sports">
<h1>Sports<a class="headerlink" href="#sports" title="Permalink to this headline"></a></h1>
<dl class="http get">
<dt id="get--api-sports">
@ -445,7 +446,7 @@ Authenticated user must be an admin</p>
</dl>
</dd></dl>
</div>
</section>
</div>
@ -459,8 +460,8 @@ Authenticated user must be an admin</p>
</p>
<p>
&copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.1.<br/>
&copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.3.<br/>
</p>
</div>
</footer>

11
docs/api/stats.html
View File

@ -3,7 +3,8 @@
<html>
<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.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>Statistics &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -124,7 +125,7 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="statistics">
<section id="statistics">
<h1>Statistics<a class="headerlink" href="#statistics" title="Permalink to this headline"></a></h1>
<dl class="http get">
<dt id="get--api-stats-(user_name)-by_time">
@ -384,7 +385,7 @@
</dl>
</dd></dl>
</div>
</section>
</div>
@ -398,8 +399,8 @@
</p>
<p>
&copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.1.<br/>
&copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.3.<br/>
</p>
</div>
</footer>

11
docs/api/users.html
View File

@ -3,7 +3,8 @@
<html>
<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.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>Users &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -124,7 +125,7 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="users">
<section id="users">
<h1>Users<a class="headerlink" href="#users" title="Permalink to this headline"></a></h1>
<dl class="http get">
<dt id="get--api-users">
@ -475,7 +476,7 @@ one admin</p>
</dl>
</dd></dl>
</div>
</section>
</div>
@ -489,8 +490,8 @@ one admin</p>
</p>
<p>
&copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.1.<br/>
&copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.3.<br/>
</p>
</div>
</footer>

11
docs/api/workouts.html
View File

@ -3,7 +3,8 @@
<html>
<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.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>Workouts &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -124,7 +125,7 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="workouts">
<section id="workouts">
<h1>Workouts<a class="headerlink" href="#workouts" title="Permalink to this headline"></a></h1>
<dl class="http get">
<dt id="get--api-workouts">
@ -1116,7 +1117,7 @@
</dl>
</dd></dl>
</div>
</section>
</div>
@ -1130,8 +1131,8 @@
</p>
<p>
&copy; Copyright 2018 - 2020, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.1.<br/>
&copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.3.<br/>
</p>
</div>
</footer>