update documentation

This commit is contained in:
Sam 2021-11-14 22:12:29 +01:00
parent edee7a1a2a
commit b9c0748185
27 changed files with 60 additions and 37 deletions

View File

@ -1,6 +1,6 @@
# Change log # Change log
## Version 0.5.0 (unreleased) ## Version 0.5.0 (2021/11/14)
### Issues Closed ### Issues Closed
@ -21,10 +21,14 @@
### Pull Requests ### Pull Requests
* [#101](https://github.com/SamR1/FitTrackee/pull/101) - Docker updates for full files
* [#100](https://github.com/SamR1/FitTrackee/pull/100) - Add client application in docker for development
* [#98/#109](https://github.com/SamR1/FitTrackee/pull/109) - Added stopped_speed_threshold to support slow movement * [#98/#109](https://github.com/SamR1/FitTrackee/pull/109) - Added stopped_speed_threshold to support slow movement
* [#84/#93](https://github.com/SamR1/FitTrackee/pull/93) - Add elevation data and new sports * [#84/#93](https://github.com/SamR1/FitTrackee/pull/93) - Add elevation data and new sports
In this release 6 issue were closed. In this release 6 issues were closed.
**Note:** This release contains database migrations.
## Version 0.4.9 (2021/07/16) ## Version 0.4.9 (2021/07/16)
@ -42,7 +46,8 @@ In this release 6 issue were closed.
* [#82](https://github.com/SamR1/Fittrackee/issues/82) - a user can not modify his birth day * [#82](https://github.com/SamR1/Fittrackee/issues/82) - a user can not modify his birth day
* [#80](https://github.com/SamR1/Fittrackee/issues/80) - can not save notes with control characters * [#80](https://github.com/SamR1/Fittrackee/issues/80) - can not save notes with control characters
In this release 4 issue were closed. In this release 4 issues were closed.
## Version 0.4.8 (2021/07/03) ## Version 0.4.8 (2021/07/03)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 201 KiB

After

Width:  |  Height:  |  Size: 201 KiB

View File

@ -1,6 +1,6 @@
# Change log # Change log
## Version 0.5.0 (unreleased) ## Version 0.5.0 (2021/11/14)
### Issues Closed ### Issues Closed
@ -21,10 +21,14 @@
### Pull Requests ### Pull Requests
* [#101](https://github.com/SamR1/FitTrackee/pull/101) - Docker updates for full files
* [#100](https://github.com/SamR1/FitTrackee/pull/100) - Add client application in docker for development
* [#98/#109](https://github.com/SamR1/FitTrackee/pull/109) - Added stopped_speed_threshold to support slow movement * [#98/#109](https://github.com/SamR1/FitTrackee/pull/109) - Added stopped_speed_threshold to support slow movement
* [#84/#93](https://github.com/SamR1/FitTrackee/pull/93) - Add elevation data and new sports * [#84/#93](https://github.com/SamR1/FitTrackee/pull/93) - Add elevation data and new sports
In this release 6 issue were closed. In this release 6 issues were closed.
**Note:** This release contains database migrations.
## Version 0.4.9 (2021/07/16) ## Version 0.4.9 (2021/07/16)
@ -42,7 +46,8 @@ In this release 6 issue were closed.
* [#82](https://github.com/SamR1/Fittrackee/issues/82) - a user can not modify his birth day * [#82](https://github.com/SamR1/Fittrackee/issues/82) - a user can not modify his birth day
* [#80](https://github.com/SamR1/Fittrackee/issues/80) - can not save notes with control characters * [#80](https://github.com/SamR1/Fittrackee/issues/80) - can not save notes with control characters
In this release 4 issue were closed. In this release 4 issues were closed.
## Version 0.4.8 (2021/07/03) ## Version 0.4.8 (2021/07/03)

View File

@ -14,7 +14,7 @@ This application is written in Python (API) and Typescript (client):
- `Leaflet <https://leafletjs.com/>`__ to display map - `Leaflet <https://leafletjs.com/>`__ to display map
- `Chart.js <https://www.chartjs.org/>`__ to display charts with elevation and speed - `Chart.js <https://www.chartjs.org/>`__ to display charts with elevation and speed
Sports and weather icons are made by `Freepik <https://www.freepik.com/>`__ from `www.flaticon.com <https://www.flaticon.com/>`__. Logo, sports and weather icons are made by `Freepik <https://www.freepik.com/>`__ from `www.flaticon.com <https://www.flaticon.com/>`__.
Prerequisites Prerequisites
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@ -132,6 +132,8 @@ deployment method.
Email URL with credentials, see `Emails <installation.html#emails>`__. Email URL with credentials, see `Emails <installation.html#emails>`__.
.. warning::
If the email URL is invalid, the application may not start.
.. envvar:: SENDER_EMAIL .. envvar:: SENDER_EMAIL

View File

@ -731,8 +731,9 @@ dl.glossary dt {
.classifier:before { .classifier:before {
font-style: normal; font-style: normal;
margin: 0.5em; margin: 0 0.5em;
content: ":"; content: ":";
display: inline-block;
} }
abbr, acronym { abbr, acronym {

View File

@ -328,7 +328,9 @@ var Search = {
var results = []; var results = [];
for (var prefix in objects) { for (var prefix in objects) {
for (var name in objects[prefix]) { for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
var match = objects[prefix][iMatch];
var name = match[4];
var fullname = (prefix ? prefix + '.' : '') + name; var fullname = (prefix ? prefix + '.' : '') + name;
var fullnameLower = fullname.toLowerCase() var fullnameLower = fullname.toLowerCase()
if (fullnameLower.indexOf(object) > -1) { if (fullnameLower.indexOf(object) > -1) {
@ -342,7 +344,6 @@ var Search = {
} else if (parts[parts.length - 1].indexOf(object) > -1) { } else if (parts[parts.length - 1].indexOf(object) > -1) {
score += Scorer.objPartialMatch; score += Scorer.objPartialMatch;
} }
var match = objects[prefix][name];
var objname = objnames[match[1]][2]; var objname = objnames[match[1]][2];
var title = titles[match[0]]; var title = titles[match[0]];
// If more than one term searched for, we require other words to be // If more than one term searched for, we require other words to be

View File

@ -867,7 +867,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -270,7 +270,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -154,7 +154,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -251,7 +251,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -491,7 +491,7 @@ Authenticated user must be an admin</p>
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -412,7 +412,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -609,7 +609,7 @@ one admin</p>
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -1132,7 +1132,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -77,7 +77,7 @@
role="menu" role="menu"
aria-labelledby="dLabelLocalToc"><ul> aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Change log</a><ul> <li><a class="reference internal" href="#">Change log</a><ul>
<li><a class="reference internal" href="#version-0-5-0-unreleased">Version 0.5.0 (unreleased)</a><ul> <li><a class="reference internal" href="#version-0-5-0-2021-11-14">Version 0.5.0 (2021/11/14)</a><ul>
<li><a class="reference internal" href="#issues-closed">Issues Closed</a><ul> <li><a class="reference internal" href="#issues-closed">Issues Closed</a><ul>
<li><a class="reference internal" href="#new-features">New Features</a></li> <li><a class="reference internal" href="#new-features">New Features</a></li>
<li><a class="reference internal" href="#bugs-fixed">Bugs Fixed</a></li> <li><a class="reference internal" href="#bugs-fixed">Bugs Fixed</a></li>
@ -270,8 +270,8 @@
<section id="change-log"> <section id="change-log">
<h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1> <h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
<section id="version-0-5-0-unreleased"> <section id="version-0-5-0-2021-11-14">
<h2>Version 0.5.0 (unreleased)<a class="headerlink" href="#version-0-5-0-unreleased" title="Permalink to this headline"></a></h2> <h2>Version 0.5.0 (2021/11/14)<a class="headerlink" href="#version-0-5-0-2021-11-14" title="Permalink to this headline"></a></h2>
<section id="issues-closed"> <section id="issues-closed">
<h3>Issues Closed<a class="headerlink" href="#issues-closed" title="Permalink to this headline"></a></h3> <h3>Issues Closed<a class="headerlink" href="#issues-closed" title="Permalink to this headline"></a></h3>
<section id="new-features"> <section id="new-features">
@ -299,10 +299,13 @@
<section id="pull-requests"> <section id="pull-requests">
<h3>Pull Requests<a class="headerlink" href="#pull-requests" title="Permalink to this headline"></a></h3> <h3>Pull Requests<a class="headerlink" href="#pull-requests" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/pull/101">#101</a> - Docker updates for full files</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/pull/100">#100</a> - Add client application in docker for development</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/pull/109">#98/#109</a> - Added stopped_speed_threshold to support slow movement</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/pull/109">#98/#109</a> - Added stopped_speed_threshold to support slow movement</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/pull/93">#84/#93</a> - Add elevation data and new sports</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/pull/93">#84/#93</a> - Add elevation data and new sports</p></li>
</ul> </ul>
<p>In this release 6 issue were closed.</p> <p>In this release 6 issues were closed.</p>
<p><strong>Note:</strong> This release contains database migrations.</p>
</section> </section>
</section> </section>
<section id="version-0-4-9-2021-07-16"> <section id="version-0-4-9-2021-07-16">
@ -322,7 +325,7 @@
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/82">#82</a> - a user can not modify his birth day</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/82">#82</a> - a user can not modify his birth day</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/80">#80</a> - can not save notes with control characters</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/80">#80</a> - can not save notes with control characters</p></li>
</ul> </ul>
<p>In this release 4 issue were closed.</p> <p>In this release 4 issues were closed.</p>
</section> </section>
</section> </section>
</section> </section>
@ -690,7 +693,7 @@ add URL interceptors to simplify routes definition</p></li>
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -311,7 +311,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -179,7 +179,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -330,7 +330,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -185,7 +185,7 @@ Map</a>.</div>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change log</a><ul> <li class="toctree-l1"><a class="reference internal" href="changelog.html">Change log</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-5-0-unreleased">Version 0.5.0 (unreleased)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-5-0-2021-11-14">Version 0.5.0 (2021/11/14)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-4-9-2021-07-16">Version 0.4.9 (2021/07/16)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-4-9-2021-07-16">Version 0.4.9 (2021/07/16)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-4-8-2021-07-03">Version 0.4.8 (2021/07/03)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-4-8-2021-07-03">Version 0.4.8 (2021/07/03)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-4-7-2021-04-07">Version 0.4.7 (2021/04/07)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-4-7-2021-04-07">Version 0.4.7 (2021/04/07)</a></li>
@ -224,7 +224,7 @@ Map</a>.</div>
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -182,7 +182,7 @@
</dl> </dl>
</li> </li>
</ul> </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> <p>Logo, 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>
<section id="prerequisites"> <section id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2> <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
@ -349,6 +349,10 @@ see <a class="reference external" href="https://docs.sqlalchemy.org/en/13/core/p
<p><span class="versionmodified added">New in version 0.3.0.</span></p> <p><span class="versionmodified added">New in version 0.3.0.</span></p>
</div> </div>
<p>Email URL with credentials, see <a class="reference external" href="installation.html#emails">Emails</a>.</p> <p>Email URL with credentials, see <a class="reference external" href="installation.html#emails">Emails</a>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>If the email URL is invalid, the application may not start.</p>
</div>
</dd></dl> </dd></dl>
<dl class="std envvar"> <dl class="std envvar">
@ -940,7 +944,7 @@ and the password <code class="docutils literal notranslate"><span class="pre">mp
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -148,7 +148,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

File diff suppressed because one or more lines are too long

View File

@ -155,7 +155,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -152,7 +152,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

View File

@ -143,7 +143,7 @@
</p> </p>
<p> <p>
&copy; Copyright 2018 - 2021, SamR1.<br/> &copy; Copyright 2018 - 2021, SamR1.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.3.0.<br/>
</p> </p>
</div> </div>
</footer> </footer>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 201 KiB

After

Width:  |  Height:  |  Size: 201 KiB

View File

@ -14,7 +14,7 @@ This application is written in Python (API) and Typescript (client):
- `Leaflet <https://leafletjs.com/>`__ to display map - `Leaflet <https://leafletjs.com/>`__ to display map
- `Chart.js <https://www.chartjs.org/>`__ to display charts with elevation and speed - `Chart.js <https://www.chartjs.org/>`__ to display charts with elevation and speed
Sports and weather icons are made by `Freepik <https://www.freepik.com/>`__ from `www.flaticon.com <https://www.flaticon.com/>`__. Logo, sports and weather icons are made by `Freepik <https://www.freepik.com/>`__ from `www.flaticon.com <https://www.flaticon.com/>`__.
Prerequisites Prerequisites
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@ -132,6 +132,8 @@ deployment method.
Email URL with credentials, see `Emails <installation.html#emails>`__. Email URL with credentials, see `Emails <installation.html#emails>`__.
.. warning::
If the email URL is invalid, the application may not start.
.. envvar:: SENDER_EMAIL .. envvar:: SENDER_EMAIL