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-11-13 12:20:35 +01:00
parent 50094d1fda
commit 9f168c102e
4 changed files with 33 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/_sources/features.rst.txt
View File

@ -37,9 +37,15 @@ Account & preferences
- A user can reset his password (*new in 0.3.0*) - A user can reset his password (*new in 0.3.0*)
- A user can set language, timezone and first day of week. - A user can set language, timezone and first day of week.
- A user can set sport preferences (*new in 0.5.0*): - A user can set sport preferences (*new in 0.5.0*):
- disable/enable a sport (if a sport is disabled by an administrator, it can not be enabled by user). A disabled sport will not appear in dropdown when adding a workout. - change sport color (used for sport image and charts)
- change sport color (used for sport image and statistics)
- can override stopped speed threshold (for next uploaded gpx files) - can override stopped speed threshold (for next uploaded gpx files)
- disable/enable a sport.
.. note::
| If a sport is disabled by an administrator, it can not be enabled by a user. In this case, it will only appear in preferences if it has user's workouts and the user can only change sport color.
| A disabled sport (by admin or user) will not appear in dropdown when **adding a workout**.
| A workout with a disabled sport will still be displayed in the application.
Workouts Workouts
@ -75,10 +81,10 @@ Workouts
- farest distance - farest distance
- longest duration - longest duration
- maximum speed - maximum speed
- Workouts list and filter - Workouts list and filter. Only sports with workouts are displayed in sport dropdown.
.. note:: .. note::
for now, only the owner of the workout can see it. For now, only the owner of the workout can see it.
Translations Translations
^^^^^^^^^^^^ ^^^^^^^^^^^^

16
docs/features.html
View File

@ -182,14 +182,22 @@
<li><p>A user can set language, timezone and first day of week.</p></li> <li><p>A user can set language, timezone and first day of week.</p></li>
<li><dl class="simple"> <li><dl class="simple">
<dt>A user can set sport preferences (<em>new in 0.5.0</em>):</dt><dd><ul> <dt>A user can set sport preferences (<em>new in 0.5.0</em>):</dt><dd><ul>
<li><p>disable/enable a sport (if a sport is disabled by an administrator, it can not be enabled by user). A disabled sport will not appear in dropdown when adding a workout.</p></li> <li><p>change sport color (used for sport image and charts)</p></li>
<li><p>change sport color (used for sport image and statistics)</p></li>
<li><p>can override stopped speed threshold (for next uploaded gpx files)</p></li> <li><p>can override stopped speed threshold (for next uploaded gpx files)</p></li>
<li><p>disable/enable a sport.</p></li>
</ul> </ul>
</dd> </dd>
</dl> </dl>
</li> </li>
</ul> </ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<div class="line-block">
<div class="line">If a sport is disabled by an administrator, it can not be enabled by a user. In this case, it will only appear in preferences if it has user’s workouts and the user can only change sport color.</div>
<div class="line">A disabled sport (by admin or user) will not appear in dropdown when <strong>adding a workout</strong>.</div>
<div class="line">A workout with a disabled sport will still be displayed in the application.</div>
</div>
</div>
</section> </section>
<section id="workouts"> <section id="workouts">
<h3>Workouts<a class="headerlink" href="#workouts" title="Permalink to this headline"></a></h3> <h3>Workouts<a class="headerlink" href="#workouts" title="Permalink to this headline"></a></h3>
@ -242,11 +250,11 @@
</dd> </dd>
</dl> </dl>
</li> </li>
<li><p>Workouts list and filter</p></li> <li><p>Workouts list and filter. Only sports with workouts are displayed in sport dropdown.</p></li>
</ul> </ul>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>for now, only the owner of the workout can see it.</p> <p>For now, only the owner of the workout can see it.</p>
</div> </div>
</section> </section>
<section id="translations"> <section id="translations">

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

14
docsrc/source/features.rst
View File

@ -37,9 +37,15 @@ Account & preferences
- A user can reset his password (*new in 0.3.0*) - A user can reset his password (*new in 0.3.0*)
- A user can set language, timezone and first day of week. - A user can set language, timezone and first day of week.
- A user can set sport preferences (*new in 0.5.0*): - A user can set sport preferences (*new in 0.5.0*):
- disable/enable a sport (if a sport is disabled by an administrator, it can not be enabled by user). A disabled sport will not appear in dropdown when adding a workout. - change sport color (used for sport image and charts)
- change sport color (used for sport image and statistics)
- can override stopped speed threshold (for next uploaded gpx files) - can override stopped speed threshold (for next uploaded gpx files)
- disable/enable a sport.
.. note::
| If a sport is disabled by an administrator, it can not be enabled by a user. In this case, it will only appear in preferences if it has user's workouts and the user can only change sport color.
| A disabled sport (by admin or user) will not appear in dropdown when **adding a workout**.
| A workout with a disabled sport will still be displayed in the application.
Workouts Workouts
@ -75,10 +81,10 @@ Workouts
- farest distance - farest distance
- longest duration - longest duration
- maximum speed - maximum speed
- Workouts list and filter - Workouts list and filter. Only sports with workouts are displayed in sport dropdown.
.. note:: .. note::
for now, only the owner of the workout can see it. For now, only the owner of the workout can see it.
Translations Translations
^^^^^^^^^^^^ ^^^^^^^^^^^^