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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/.buildinfo
View File

@ -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: 921d33c9933121d974ed1f4a335aa18e
config: 59f40d0441f81e30af406562b2ac47c5
tags: 645f666f9bcd5a90fca523b33c5a78b7

2
docs/_sources/installation.rst.txt
View File

@ -108,6 +108,8 @@ deployment method.
| Database URL with username and password, must be initialized in production environment.
| For example in dev environment : ``postgresql://fittrackee:fittrackee@localhost:5432/fittrackee``
.. danger::
| Since SQLAlchemy update (1.4+), engine URL should begin with `postgresql://`.
.. envvar:: DATABASE_DISABLE_POOLING 🆕

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>

223
docs/changelog.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>Change log &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -234,13 +235,13 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="change-log">
<section id="change-log">
<h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
<div class="section" id="version-0-4-6-2021-02-21">
<section id="version-0-4-6-2021-02-21">
<h2>Version 0.4.6 (2021/02/21)<a class="headerlink" href="#version-0-4-6-2021-02-21" title="Permalink to this headline"></a></h2>
<div class="section" id="issues-closed">
<section id="issues-closed">
<h3>Issues Closed<a class="headerlink" href="#issues-closed" title="Permalink to this headline"></a></h3>
<div class="section" id="bugs-fixed">
<section id="bugs-fixed">
<h4>Bugs Fixed<a class="headerlink" href="#bugs-fixed" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/72">#72</a> - Error message when file exceeding size is incorrect</p></li>
@ -248,84 +249,84 @@
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/70">#70</a> - max size for an archive must not be less than uploaded files max size</p></li>
</ul>
<p>In this release 3 issues were closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-4-5-2021-02-17">
</section>
</section>
</section>
<section id="version-0-4-5-2021-02-17">
<h2>Version 0.4.5 (2021/02/17)<a class="headerlink" href="#version-0-4-5-2021-02-17" title="Permalink to this headline"></a></h2>
<div class="section" id="id1">
<section id="id1">
<h3>Issues Closed<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<div class="section" id="id2">
<section id="id2">
<h4>Bugs Fixed<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/66">#66</a> - invalid gpx limit used when importing zip archive</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/64">#64</a> - Only 50 workouts per month shown in calendar</p></li>
</ul>
<p>In this release 2 issues were closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-4-4-2021-01-31">
</section>
</section>
</section>
<section id="version-0-4-4-2021-01-31">
<h2>Version 0.4.4 (2021/01/31)<a class="headerlink" href="#version-0-4-4-2021-01-31" title="Permalink to this headline"></a></h2>
<div class="section" id="id3">
<section id="id3">
<h3>Issues Closed<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<div class="section" id="id4">
<section id="id4">
<h4>Bugs Fixed<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/62">#62</a> - Error when sending reset password email</p></li>
</ul>
</div>
</div>
<div class="section" id="misc">
</section>
</section>
<section id="misc">
<h3>Misc<a class="headerlink" href="#misc" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Refactoring before introducing new features.</p></li>
<li><p>Add docker files for evaluation purposes.</p></li>
</ul>
<p>In this release 1 issue was closed.</p>
</div>
</div>
<div class="section" id="version-0-4-3-2021-01-10">
</section>
</section>
<section id="version-0-4-3-2021-01-10">
<h2>Version 0.4.3 (2021/01/10)<a class="headerlink" href="#version-0-4-3-2021-01-10" title="Permalink to this headline"></a></h2>
<div class="section" id="id5">
<section id="id5">
<h3>Issues Closed<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<div class="section" id="new-features">
<section id="new-features">
<h4>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/58">#58</a> - Standardize terms used for workouts<br /><strong>Note:</strong> Database model, upload directory for workouts and API endpoints are also updated.</p></li>
</ul>
</div>
<div class="section" id="id6">
</section>
<section id="id6">
<h4>Bugs Fixed<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/59">#59</a> - No message displayed on uploading image error</p></li>
</ul>
<p>In this release 2 issues were closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-4-2-2021-01-03">
</section>
</section>
</section>
<section id="version-0-4-2-2021-01-03">
<h2>Version 0.4.2 (2021/01/03)<a class="headerlink" href="#version-0-4-2-2021-01-03" title="Permalink to this headline"></a></h2>
<div class="section" id="id7">
<section id="id7">
<h3>Misc<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<p>No new features in this release, only some refactorings before introducing
new features.</p>
</div>
</div>
<div class="section" id="version-0-4-1-2020-12-31">
</section>
</section>
<section id="version-0-4-1-2020-12-31">
<h2>Version 0.4.1 (2020/12/31)<a class="headerlink" href="#version-0-4-1-2020-12-31" title="Permalink to this headline"></a></h2>
<div class="section" id="id8">
<section id="id8">
<h3>Issues Closed<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<div class="section" id="id9">
<section id="id9">
<h4>New Features<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/57">#57</a> - Use uuid for activities</p></li>
</ul>
<p>In this release 1 issue was closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-4-0-fittrackee-on-pypi-2020-09-19">
</section>
</section>
</section>
<section id="version-0-4-0-fittrackee-on-pypi-2020-09-19">
<h2>Version 0.4.0 - FitTrackee on PyPI (2020/09/19)<a class="headerlink" href="#version-0-4-0-fittrackee-on-pypi-2020-09-19" title="Permalink to this headline"></a></h2>
<p>This version introduces some major changes:</p>
<ul class="simple">
@ -333,28 +334,28 @@ new features.</p>
<li><p>It’s now possible to change the tile provider for maps. The default tile server is now <strong>OpenStreetMap</strong>’s standard tile layer (replacing <strong>ThunderForest Outdoors</strong>),
see <a class="reference external" href="https://samr1.github.io/FitTrackee/installation.html#map-tile-server">Map tile server in documentation</a>.</p></li>
</ul>
<div class="section" id="id10">
<section id="id10">
<h3>Issues Closed<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
<div class="section" id="id11">
<section id="id11">
<h4>New Features<a class="headerlink" href="#id11" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/54">#54</a> - Tile server can be changed</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/53">#53</a> - Simplify FitTrackee installation</p></li>
</ul>
<p>In this release 2 issue were closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-3-0-administration-2020-07-15">
</section>
</section>
</section>
<section id="version-0-3-0-administration-2020-07-15">
<h2>Version 0.3.0 - Administration (2020/07/15)<a class="headerlink" href="#version-0-3-0-administration-2020-07-15" title="Permalink to this headline"></a></h2>
<p>This version introduces some major changes:</p>
<ul class="simple">
<li><p>FitTrackee administration is now available (see <a class="reference external" href="https://samr1.github.io/FitTrackee/features.html#administration">documentation</a>)<br />⚠️ Warning: some application parameters move from environment variables to database (see <a class="reference external" href="https://samr1.github.io/FitTrackee/installation.html#environment-variables">installation</a>).</p></li>
<li><p>in order to send emails, Redis is now a mandatory dependency</p></li>
</ul>
<div class="section" id="id12">
<section id="id12">
<h3>Issues Closed<a class="headerlink" href="#id12" title="Permalink to this headline"></a></h3>
<div class="section" id="id13">
<section id="id13">
<h4>New Features<a class="headerlink" href="#id13" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/50">#50</a> - A user can reset his password</p></li>
@ -362,12 +363,12 @@ see <a class="reference external" href="https://samr1.github.io/FitTrackee/insta
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/15">#15</a> - Complete the administration</p></li>
</ul>
<p>In this release 3 issues were closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-2-5-fix-and-improvements-2020-01-31">
</section>
</section>
</section>
<section id="version-0-2-5-fix-and-improvements-2020-01-31">
<h2>Version 0.2.5 - Fix and improvements (2020/01/31)<a class="headerlink" href="#version-0-2-5-fix-and-improvements-2020-01-31" title="Permalink to this headline"></a></h2>
<div class="section" id="id14">
<section id="id14">
<h3>Misc<a class="headerlink" href="#id14" title="Permalink to this headline"></a></h3>
<p>This version contains minor fix and improvements on client side:</p>
<ul class="simple">
@ -377,60 +378,60 @@ see <a class="reference external" href="https://samr1.github.io/FitTrackee/insta
<a class="reference external" href="https://github.com/SamR1/FitTrackee/commit/2e1ee2c7a1456eb2fe0c0255959c695cc7908975">2e1ee2c</a> -
add URL interceptors to simplify routes definition</p></li>
</ul>
</div>
</div>
<div class="section" id="version-0-2-4-minor-fix-2020-01-30">
</section>
</section>
<section id="version-0-2-4-minor-fix-2020-01-30">
<h2>Version 0.2.4 - Minor fix (2020/01/30)<a class="headerlink" href="#version-0-2-4-minor-fix-2020-01-30" title="Permalink to this headline"></a></h2>
<div class="section" id="id15">
<section id="id15">
<h3>Issues Closed<a class="headerlink" href="#id15" title="Permalink to this headline"></a></h3>
<div class="section" id="id16">
<section id="id16">
<h4>Bugs Fixed<a class="headerlink" href="#id16" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/47">#47</a> - timezone drop-down is not displayed correctly</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/46">#46</a> - calendar cannot display more than 5 or 6 activities on the same day</p></li>
</ul>
<p>In this release 2 issues were closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-2-3-fittrackee-available-in-french-2019-12-29">
</section>
</section>
</section>
<section id="version-0-2-3-fittrackee-available-in-french-2019-12-29">
<h2>Version 0.2.3 - FitTrackee available in French (2019/12/29)<a class="headerlink" href="#version-0-2-3-fittrackee-available-in-french-2019-12-29" title="Permalink to this headline"></a></h2>
<div class="section" id="id17">
<section id="id17">
<h3>Issues Closed<a class="headerlink" href="#id17" title="Permalink to this headline"></a></h3>
<div class="section" id="id18">
<section id="id18">
<h4>New Features<a class="headerlink" href="#id18" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/43">#43</a> - Display weekend days with a different background color on calendar</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/40">#40</a> - Localize FitTrackee (i18n)</p></li>
</ul>
</div>
<div class="section" id="id19">
</section>
<section id="id19">
<h4>Bugs Fixed<a class="headerlink" href="#id19" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/44">#44</a> - Cannot edit an activity that does not have a gpx file</p></li>
</ul>
<p>In this release 3 issues were closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-2-2-statistics-fix-2019-09-23">
</section>
</section>
</section>
<section id="version-0-2-2-statistics-fix-2019-09-23">
<h2>Version 0.2.2 - Statistics fix (2019/09/23)<a class="headerlink" href="#version-0-2-2-statistics-fix-2019-09-23" title="Permalink to this headline"></a></h2>
<div class="section" id="id20">
<section id="id20">
<h3>Issues Closed<a class="headerlink" href="#id20" title="Permalink to this headline"></a></h3>
<div class="section" id="id21">
<section id="id21">
<h4>Bugs Fixed<a class="headerlink" href="#id21" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/41">#41</a> - User statistics are incorrect</p></li>
</ul>
<p>In this release 1 issue was closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-2-1-fix-and-improvements-2019-09-01">
</section>
</section>
</section>
<section id="version-0-2-1-fix-and-improvements-2019-09-01">
<h2>Version 0.2.1 - Fix and improvements (2019/09/01)<a class="headerlink" href="#version-0-2-1-fix-and-improvements-2019-09-01" title="Permalink to this headline"></a></h2>
<div class="section" id="id22">
<section id="id22">
<h3>Issues Closed<a class="headerlink" href="#id22" title="Permalink to this headline"></a></h3>
<div class="section" id="id23">
<section id="id23">
<h4>New Features<a class="headerlink" href="#id23" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/4">#4</a> - Show points on the map when mouse over the chart</p></li>
@ -441,53 +442,53 @@ add URL interceptors to simplify routes definition</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/33">#33</a> - Add file size limit on file upload</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/37">#37</a> - Display map on activities list</p></li>
</ul>
</div>
<div class="section" id="id24">
</section>
<section id="id24">
<h4>Bugs Fixed<a class="headerlink" href="#id24" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/34">#34</a> - Weather is not displayed anymore</p></li>
</ul>
</div>
</div>
<div class="section" id="id25">
</section>
</section>
<section id="id25">
<h3>Misc<a class="headerlink" href="#id25" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><strong><a class="reference external" href="https://poetry.eustace.io/">Poetry</a></strong> replaces <strong><a class="reference external" href="https://docs.pipenv.org">pipenv</a></strong> for Python packages management</p></li>
</ul>
<p>In this release 8 issues were closed.</p>
</div>
</div>
<div class="section" id="version-0-2-0-statistics-2019-07-07">
</section>
</section>
<section id="version-0-2-0-statistics-2019-07-07">
<h2>Version 0.2.0 - Statistics (2019/07/07)<a class="headerlink" href="#version-0-2-0-statistics-2019-07-07" title="Permalink to this headline"></a></h2>
<div class="section" id="id26">
<section id="id26">
<h3>Issues Closed<a class="headerlink" href="#id26" title="Permalink to this headline"></a></h3>
<div class="section" id="id27">
<section id="id27">
<h4>New Features<a class="headerlink" href="#id27" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/13">#13</a> - Detailed statistics</p></li>
</ul>
</div>
</div>
<div class="section" id="id28">
</section>
</section>
<section id="id28">
<h3>Misc<a class="headerlink" href="#id28" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Update dependencies</p></li>
</ul>
<p>In this release 1 issue was closed.</p>
</div>
</div>
<div class="section" id="version-0-1-1-fix-and-improvements-2019-02-07">
</section>
</section>
<section id="version-0-1-1-fix-and-improvements-2019-02-07">
<h2>Version 0.1.1 - Fix and improvements (2019/02/07)<a class="headerlink" href="#version-0-1-1-fix-and-improvements-2019-02-07" title="Permalink to this headline"></a></h2>
<div class="section" id="id29">
<section id="id29">
<h3>Issues Closed<a class="headerlink" href="#id29" title="Permalink to this headline"></a></h3>
<div class="section" id="id30">
<section id="id30">
<h4>New Features<a class="headerlink" href="#id30" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/25">#25</a> - Display records on calendar</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/22">#22</a> - Add a total on current month statistics</p></li>
</ul>
</div>
<div class="section" id="id31">
</section>
<section id="id31">
<h4>Bugs Fixed<a class="headerlink" href="#id31" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/31">#31</a> - Use moving duration for stats</p></li>
@ -497,10 +498,10 @@ add URL interceptors to simplify routes definition</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/24">#24</a> - Some distances are not displayed correctly on current month statistics</p></li>
</ul>
<p>In this release 7 issues were closed.</p>
</div>
</div>
</div>
<div class="section" id="version-0-1-0-first-release-2018-07-04">
</section>
</section>
</section>
<section id="version-0-1-0-first-release-2018-07-04">
<h2>Version 0.1.0 - First release 🎉 (2018-07-04)<a class="headerlink" href="#version-0-1-0-first-release-2018-07-04" title="Permalink to this headline"></a></h2>
<p><strong>Features:</strong></p>
<ul class="simple">
@ -537,9 +538,9 @@ add URL interceptors to simplify routes definition</p></li>
<li><p>no administration for now</p></li>
</ul>
<p>➡️ more informations: see <a class="reference external" href="https://samr1.github.io/FitTrackee/">documentation</a> and <a class="reference external" href="https://github.com/SamR1/FitTrackee/issues">current issues</a></p>
<div class="section" id="id32">
<section id="id32">
<h3>Issues Closed<a class="headerlink" href="#id32" title="Permalink to this headline"></a></h3>
<div class="section" id="id33">
<section id="id33">
<h4>New Features<a class="headerlink" href="#id33" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/11">#11</a> - Timezone support</p></li>
@ -550,10 +551,10 @@ add URL interceptors to simplify routes definition</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/2">#2</a> - Calendar to view activities</p></li>
</ul>
<p>In this release 6 issues were closed.</p>
</div>
</div>
</div>
</div>
</section>
</section>
</section>
</section>
</div>
@ -567,8 +568,8 @@ add URL interceptors to simplify routes definition</p></li>
</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>

71
docs/features.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>Features &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -138,11 +139,11 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="features">
<section id="features">
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<div class="section" id="list">
<section id="list">
<h2>List<a class="headerlink" href="#list" title="Permalink to this headline"></a></h2>
<div class="section" id="administration">
<section id="administration">
<h3>Administration<a class="headerlink" href="#administration" title="Permalink to this headline"></a></h3>
<p>(<em>new in 0.3.0</em>)</p>
<ul>
@ -172,15 +173,15 @@
</ul>
</li>
</ul>
</div>
<div class="section" id="account">
</section>
<section id="account">
<h3>Account<a class="headerlink" href="#account" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>A user can create, update and deleted his account</p></li>
<li><p>A user can reset his password (<em>new in 0.3.0</em>)</p></li>
</ul>
</div>
<div class="section" id="workouts">
</section>
<section id="workouts">
<h3>Workouts<a class="headerlink" href="#workouts" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><dl class="simple">
@ -216,43 +217,43 @@
<p class="admonition-title">Note</p>
<p>for now, only the owner of the workout can see it.</p>
</div>
</div>
<div class="section" id="translations">
</section>
<section id="translations">
<h3>Translations<a class="headerlink" href="#translations" title="Permalink to this headline"></a></h3>
<p>FitTrackee is available in English and French (which can be saved in the user settings).</p>
</div>
</div>
<div class="section" id="dashboard">
</section>
</section>
<section id="dashboard">
<h2>Dashboard<a class="headerlink" href="#dashboard" title="Permalink to this headline"></a></h2>
<div class="figure align-default">
<figure class="align-default">
<img alt="FitTrackee Dashboard" src="_images/fittrackee_screenshot-01.png" />
</div>
</div>
<div class="section" id="workout-detail">
</figure>
</section>
<section id="workout-detail">
<h2>Workout detail<a class="headerlink" href="#workout-detail" title="Permalink to this headline"></a></h2>
<div class="figure align-default">
<figure class="align-default">
<img alt="FitTrackee Workout" src="_images/fittrackee_screenshot-02.png" />
</div>
</div>
<div class="section" id="workouts-list">
</figure>
</section>
<section id="workouts-list">
<h2>Workouts list<a class="headerlink" href="#workouts-list" title="Permalink to this headline"></a></h2>
<div class="figure align-default">
<figure class="align-default">
<img alt="FitTrackee Workouts" src="_images/fittrackee_screenshot-03.png" />
</div>
</div>
<div class="section" id="statistics">
</figure>
</section>
<section id="statistics">
<h2>Statistics<a class="headerlink" href="#statistics" title="Permalink to this headline"></a></h2>
<div class="figure align-default">
<figure class="align-default">
<img alt="FitTrackee Statistics" src="_images/fittrackee_screenshot-04.png" />
</div>
</div>
<div class="section" id="id1">
</figure>
</section>
<section id="id1">
<h2>Administration<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
<div class="figure align-default">
<figure class="align-default">
<img alt="FitTrackee Administration" src="_images/fittrackee_screenshot-05.png" />
</div>
</div>
</div>
</figure>
</section>
</section>
</div>
@ -266,8 +267,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>

4
docs/genindex.html
View File

@ -186,8 +186,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>

4
docs/http-routingtable.html
View File

@ -319,8 +319,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>

19
docs/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>FitTrackee &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -120,7 +121,7 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="fittrackee">
<section id="fittrackee">
<h1>FitTrackee<a class="headerlink" href="#fittrackee" title="Permalink to this headline"></a></h1>
<div class="line-block">
<div class="line">This web application allows you to track your outdoor activities (workouts)
@ -145,11 +146,11 @@ Map</a>.</div>
<div class="line"><strong>Still under heavy development (some features may be unstable).</strong></div>
<div class="line">(see <a class="reference external" href="https://github.com/SamR1/FitTrackee/issues">issues</a> for more information)</div>
</div>
<div class="figure align-default">
<figure class="align-default">
<img alt="FitTrackee Dashboard" src="_images/fittrackee_screenshot-01.png" />
</div>
</div>
<div class="section" id="table-of-contents">
</figure>
</section>
<section id="table-of-contents">
<h1>Table of contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
@ -207,7 +208,7 @@ Map</a>.</div>
</li>
</ul>
</div>
</div>
</section>
</div>
@ -221,8 +222,8 @@ Map</a>.</div>
</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>

85
docs/installation.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>Installation &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -153,7 +154,7 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="installation">
<section id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p>This application is written in Python (API) and Javascript (client):</p>
<ul class="simple">
@ -179,7 +180,7 @@
</li>
</ul>
<p>Sports and weather icons are made by <a class="reference external" href="https://www.freepik.com/">Freepik</a> from <a class="reference external" href="https://www.flaticon.com/">www.flaticon.com</a>.</p>
<div class="section" id="prerequisites">
<section id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>PostgreSQL database (10+)</p></li>
@ -200,8 +201,8 @@ on Debian and Arch).</div>
necessary.</div>
</div>
</div>
</div>
<div class="section" id="environment-variables">
</section>
<section id="environment-variables">
<h2>Environment variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline"></a></h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@ -308,6 +309,12 @@ deployment method.</p>
<div class="line">Database URL with username and password, must be initialized in production environment.</div>
<div class="line">For example in dev environment : <code class="docutils literal notranslate"><span class="pre">postgresql://fittrackee:fittrackee&#64;localhost:5432/fittrackee</span></code></div>
</div>
<div class="admonition danger">
<p class="admonition-title">Danger</p>
<div class="line-block">
<div class="line">Since SQLAlchemy update (1.4+), engine URL should begin with <cite>postgresql://</cite>.</div>
</div>
</div>
</dd></dl>
<dl class="std envvar">
@ -415,7 +422,7 @@ see <a class="reference external" href="https://docs.sqlalchemy.org/en/13/core/p
<dd><p><strong>FitTrackee</strong> API URL, only needed in dev environment.</p>
</dd></dl>
<div class="section" id="deprecated-variables">
<section id="deprecated-variables">
<h3>Deprecated variables<a class="headerlink" href="#deprecated-variables" title="Permalink to this headline"></a></h3>
<dl class="std envvar">
<dt id="envvar-REACT_APP_GPX_LIMIT_IMPORT">
@ -489,8 +496,8 @@ see <a class="reference external" href="https://docs.sqlalchemy.org/en/13/core/p
<div class="line">Related environment variables are needed to initialize database when upgrading from version prior 0.3.0.</div>
</div>
</div>
</div>
<div class="section" id="emails">
</section>
<section id="emails">
<h3>Emails<a class="headerlink" href="#emails" title="Permalink to this headline"></a></h3>
<div class="versionadded">
<p><span class="versionmodified added">New in version 0.3.0.</span></p>
@ -501,8 +508,8 @@ see <a class="reference external" href="https://docs.sqlalchemy.org/en/13/core/p
<li><p>with SSL: <code class="docutils literal notranslate"><span class="pre">smtp://username:password&#64;smtp.example.com:465/?ssl=True</span></code></p></li>
<li><p>with STARTTLS: <code class="docutils literal notranslate"><span class="pre">smtp://username:password&#64;smtp.example.com:587/?tls=True</span></code></p></li>
</ul>
</div>
<div class="section" id="map-tile-server">
</section>
<section id="map-tile-server">
<h3>Map tile server<a class="headerlink" href="#map-tile-server" title="Permalink to this headline"></a></h3>
<div class="versionadded">
<p><span class="versionmodified added">New in version 0.4.0.</span></p>
@ -520,9 +527,9 @@ The tile server can be changed by updating <code class="docutils literal notrans
<div class="line">Check the terms of service of tile provider for map attribution</div>
</div>
</div>
</div>
</div>
<div class="section" id="from-pypi">
</section>
</section>
<section id="from-pypi">
<h2>From PyPI<a class="headerlink" href="#from-pypi" title="Permalink to this headline"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
@ -536,7 +543,7 @@ The tile server can be changed by updating <code class="docutils literal notrans
<div class="line">Note that FitTrackee is under heavy development, some features may be unstable.</div>
</div>
</div>
<div class="section" id="id1">
<section id="id1">
<h3>Installation<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Create and activate a virtualenv</p></li>
@ -592,8 +599,8 @@ $ <span class="nb">source</span> .env
<div class="line">To start application and workers with <strong>systemd</strong> service, see <a class="reference external" href="installation.html#deployment">Deployment</a></div>
</div>
</div>
</div>
<div class="section" id="upgrade">
</section>
<section id="upgrade">
<h3>Upgrade<a class="headerlink" href="#upgrade" title="Permalink to this headline"></a></h3>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@ -626,9 +633,9 @@ $ <span class="nb">source</span> .env
<ul class="simple">
<li><p>Restart the application and task queue workers.</p></li>
</ul>
</div>
</div>
<div class="section" id="from-sources">
</section>
</section>
<section id="from-sources">
<h2>From sources<a class="headerlink" href="#from-sources" title="Permalink to this headline"></a></h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@ -646,9 +653,9 @@ $ poetry config virtualenvs.in-project <span class="nb">true</span>
</div>
<p>For other OS, see <a class="reference external" href="https://python-poetry.org/docs/#installation">Poetry Documentation</a></p>
</div>
<div class="section" id="id2">
<section id="id2">
<h3>Installation<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="section" id="dev-environment">
<section id="dev-environment">
<h4>Dev environment<a class="headerlink" href="#dev-environment" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p>Clone this repo:</p></li>
@ -681,8 +688,8 @@ $ make install-db
</div>
<p>Open <a class="reference external" href="http://localhost:3000">http://localhost:3000</a> and log in (the email is <code class="docutils literal notranslate"><span class="pre">admin&#64;example.com</span></code>
and the password <code class="docutils literal notranslate"><span class="pre">mpwoadmin</span></code>) or register</p>
</div>
<div class="section" id="production-environment">
</section>
<section id="production-environment">
<h4>Production environment<a class="headerlink" href="#production-environment" title="Permalink to this headline"></a></h4>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@ -723,9 +730,9 @@ database credentials</strong>):</p></li>
<p>Open <a class="reference external" href="http://localhost:5000">http://localhost:5000</a>, log in as admin (the email is
<code class="docutils literal notranslate"><span class="pre">admin&#64;example.com</span></code> and the password <code class="docutils literal notranslate"><span class="pre">mpwoadmin</span></code>) and change the
password</p>
</div>
</div>
<div class="section" id="id3">
</section>
</section>
<section id="id3">
<h3>Upgrade<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@ -735,7 +742,7 @@ password</p>
<div class="line">- upload directory (see <a class="reference external" href="installation.html#environment-variables">Environment variables</a>)</div>
</div>
</div>
<div class="section" id="id4">
<section id="id4">
<h4>Dev environment<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p>Stop the application and pull the repository:</p></li>
@ -763,8 +770,8 @@ $ make upgrade-db
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make run-workers
</pre></div>
</div>
</div>
<div class="section" id="prod-environment">
</section>
<section id="prod-environment">
<h4>Prod environment<a class="headerlink" href="#prod-environment" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p>Stop the application and pull the repository:</p></li>
@ -786,10 +793,10 @@ $ make upgrade-db
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make run
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="deployment">
</section>
</section>
</section>
<section id="deployment">
<h2>Deployment<a class="headerlink" href="#deployment" title="Permalink to this headline"></a></h2>
<p>There are several ways to start <strong>FitTrackee</strong> web application and task queue
library.
@ -903,8 +910,8 @@ server {
<p class="admonition-title">Note</p>
<p>If needed, update configuration to handle larger files (see <a class="reference external" href="https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size">client_max_body_size</a>).</p>
</div>
</div>
<div class="section" id="docker">
</section>
<section id="docker">
<h2>Docker<a class="headerlink" href="#docker" title="Permalink to this headline"></a></h2>
<div class="versionadded">
<p><span class="versionmodified added">New in version 0.4.4.</span></p>
@ -939,8 +946,8 @@ $ make docker-build docker-run docker-init
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make docker-shell
</pre></div>
</div>
</div>
</div>
</section>
</section>
</div>
@ -954,8 +961,8 @@ $ make docker-build docker-run docker-init
</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>

4
docs/search.html
View File

@ -147,8 +147,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>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

15
docs/troubleshooting/administrator.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>Administrator &#8212; FitTrackee 0.4.6
documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -127,14 +128,14 @@
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="administrator">
<section id="administrator">
<h1>Administrator<a class="headerlink" href="#administrator" title="Permalink to this headline"></a></h1>
<div class="section" id="json-parse-unexpected-character-at-line-1-column-1-of-the-json-data">
<section id="json-parse-unexpected-character-at-line-1-column-1-of-the-json-data">
<h2><cite>JSON.parse: unexpected character at line 1 column 1 of the JSON data</cite><a class="headerlink" href="#json-parse-unexpected-character-at-line-1-column-1-of-the-json-data" title="Permalink to this headline"></a></h2>
<p>On the <strong>Network Tab</strong>, if the requests are made to <cite>http://localhost:3000/undefined/api</cite>, that means the environnement variable <strong>REACT_APP_API_URL</strong> is not initialized.</p>
<p>Check if <strong>Makefile.custom.config</strong> file exists and <strong>REACT_APP_API_URL</strong> is correctly initialized (see <a class="reference external" href="https://github.com/SamR1/FitTrackee/blob/master/Makefile.custom.config.example">example</a>), and rebuild the client.</p>
</div>
</div>
</section>
</section>
</div>
@ -148,8 +149,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/troubleshooting/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>Troubleshooting &#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="troubleshooting">
<section id="troubleshooting">
<h1>Troubleshooting<a class="headerlink" href="#troubleshooting" 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="administrator.html">Administrator</a><ul>
<li class="toctree-l2"><a class="reference internal" href="administrator.html#json-parse-unexpected-character-at-line-1-column-1-of-the-json-data"><cite>JSON.parse: unexpected character at line 1 column 1 of the JSON data</cite></a></li>
@ -136,7 +137,7 @@
<li class="toctree-l1"><a class="reference internal" href="user.html">User</a></li>
</ul>
</div>
</div>
</section>
</div>
@ -150,8 +151,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/troubleshooting/user.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>User &#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="user">
<section id="user">
<h1>User<a class="headerlink" href="#user" title="Permalink to this headline"></a></h1>
<p><code class="docutils literal notranslate"><span class="pre">TODO</span></code></p>
</div>
</section>
</div>
@ -141,8 +142,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>

2
docsrc/source/conf.py
View File

@ -26,7 +26,7 @@ def setup(app):
# -- Project information -----------------------------------------------------
project = 'FitTrackee'
copyright = '2018 - 2020, SamR1'
copyright = '2018 - 2021, SamR1'
author = 'SamR1'
# The full version, including alpha/beta/rc tags.

2
docsrc/source/installation.rst
View File

@ -108,6 +108,8 @@ deployment method.
| Database URL with username and password, must be initialized in production environment.
| For example in dev environment : ``postgresql://fittrackee:fittrackee@localhost:5432/fittrackee``
.. danger::
| Since SQLAlchemy update (1.4+), engine URL should begin with `postgresql://`.
.. envvar:: DATABASE_DISABLE_POOLING 🆕