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
2019-08-25 21:21:34 +02:00
parent c50d7b1966
commit ea3fc6aafa
9 changed files with 105 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@@ -4,6 +4,8 @@
#### New Features #### New Features
* [#4](https://github.com/SamR1/Fittrackee/issues/4) - Show points on the map when mouse over the chart
* [#14](https://github.com/SamR1/Fittrackee/issues/14) - Display segments informations
* [#21](https://github.com/SamR1/Fittrackee/issues/21) - Document the API * [#21](https://github.com/SamR1/Fittrackee/issues/21) - Document the API
* [#36](https://github.com/SamR1/Fittrackee/issues/36) - Disable user registration * [#36](https://github.com/SamR1/Fittrackee/issues/36) - Disable user registration
@@ -11,7 +13,7 @@
* [#34](https://github.com/SamR1/Fittrackee/issues/34) - Weather is not displayed anymore * [#34](https://github.com/SamR1/Fittrackee/issues/34) - Weather is not displayed anymore
In this release 2 issue were closed. In this release 5 issue were closed.
## Version 0.2.0 - Statistics (2019/07/07) ## Version 0.2.0 - Statistics (2019/07/07)

19
docs/_sources/changelog.md.txt
View File

@@ -1,5 +1,21 @@
# Change log # Change log
## Version 0.2.1 (2019/xx/xx)
#### New Features
* [#4](https://github.com/SamR1/Fittrackee/issues/4) - Show points on the map when mouse over the chart
* [#14](https://github.com/SamR1/Fittrackee/issues/14) - Display segments informations
* [#21](https://github.com/SamR1/Fittrackee/issues/21) - Document the API
* [#36](https://github.com/SamR1/Fittrackee/issues/36) - Disable user registration
#### Bugs Fixed
* [#34](https://github.com/SamR1/Fittrackee/issues/34) - Weather is not displayed anymore
In this release 5 issue were closed.
## Version 0.2.0 - Statistics (2019/07/07) ## Version 0.2.0 - Statistics (2019/07/07)
### Issues Closed ### Issues Closed
@@ -32,11 +48,10 @@ In this release 1 issue was closed.
* [#26](https://github.com/SamR1/FitTrackee/issues/26) - Total is incorrect in tooltip when duration is displayed * [#26](https://github.com/SamR1/FitTrackee/issues/26) - Total is incorrect in tooltip when duration is displayed
* [#24](https://github.com/SamR1/FitTrackee/issues/24) - Some distances are not displayed correctly on current month statistics * [#24](https://github.com/SamR1/FitTrackee/issues/24) - Some distances are not displayed correctly on current month statistics
In this release 7 issues were closed. In this release 7 issues were closed.
## Version 0.1.0 - Minimal version (2018-07-04) ## Version 0.1 - Minimal version (2018-07-04)
### Issues Closed ### Issues Closed

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

@@ -3,7 +3,14 @@ Features
List List
~~~~ ~~~~
Users
^^^^^
- Account creation (only standard user, not admin) - Account creation (only standard user, not admin)
- User registration can be disabled
Activities/Workouts
^^^^^^^^^^^^^^^^^^^
- 6 sports supported: - 6 sports supported:
- Cycling (Sport) - Cycling (Sport)
- Cycling (Transport) - Cycling (Transport)
@@ -11,10 +18,10 @@ List
- Montain Biking - Montain Biking
- Running - Running
- Walking - Walking
- Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)
- An activity with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation)
- Activity edition and deletion. User can add a note
- Dashboard with month calendar displaying activities and record - Dashboard with month calendar displaying activities and record
- Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)
- An activity with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed
- Activity edition and deletion. User can add a note
- User statistics - User statistics
- User records by sports: - User records by sports:
- average speed - average speed
@@ -22,7 +29,6 @@ List
- longest duration - longest duration
- maximum speed - maximum speed
- Activities list and filter - Activities list and filter
- User registration can be disabled.
**Notes:** **Notes:**

64
docs/changelog.html
View File

@@ -74,25 +74,30 @@
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-2-1-2019-xx-xx">Version 0.2.1 (2019/xx/xx)</a><ul>
<li><a class="reference internal" href="#new-features">New Features</a></li>
<li><a class="reference internal" href="#bugs-fixed">Bugs Fixed</a></li>
</ul>
</li>
<li><a class="reference internal" href="#version-0-2-0-statistics-2019-07-07">Version 0.2.0 - Statistics (2019/07/07)</a><ul> <li><a class="reference internal" href="#version-0-2-0-statistics-2019-07-07">Version 0.2.0 - Statistics (2019/07/07)</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="#id1">New Features</a></li>
<li><a class="reference internal" href="#misc">Misc</a></li> <li><a class="reference internal" href="#misc">Misc</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#version-0-1-1-fix-and-improvements-2019-02-07">Version 0.1.1 - Fix and improvements (2019/02/07)</a><ul> <li><a class="reference internal" href="#version-0-1-1-fix-and-improvements-2019-02-07">Version 0.1.1 - Fix and improvements (2019/02/07)</a><ul>
<li><a class="reference internal" href="#id1">Issues Closed</a><ul> <li><a class="reference internal" href="#id2">Issues Closed</a><ul>
<li><a class="reference internal" href="#id2">New Features</a></li> <li><a class="reference internal" href="#id3">New Features</a></li>
<li><a class="reference internal" href="#bugs-fixed">Bugs Fixed</a></li> <li><a class="reference internal" href="#id4">Bugs Fixed</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#version-0-1-0-minimal-version-2018-07-04">Version 0.1.0 - Minimal version (2018-07-04)</a><ul> <li><a class="reference internal" href="#version-0-1-minimal-version-2018-07-04">Version 0.1 - Minimal version (2018-07-04)</a><ul>
<li><a class="reference internal" href="#id3">Issues Closed</a><ul> <li><a class="reference internal" href="#id5">Issues Closed</a><ul>
<li><a class="reference internal" href="#id4">New Features</a></li> <li><a class="reference internal" href="#id6">New Features</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@@ -144,12 +149,31 @@
<div class="section" id="change-log"> <div class="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>
<div class="section" id="version-0-2-1-2019-xx-xx">
<h2>Version 0.2.1 (2019/xx/xx)<a class="headerlink" href="#version-0-2-1-2019-xx-xx" title="Permalink to this headline"></a></h2>
<div class="section" id="new-features">
<h3>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h3>
<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>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/14">#14</a> - Display segments informations</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/21">#21</a> - Document the API</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/36">#36</a> - Disable user registration</p></li>
</ul>
</div>
<div class="section" id="bugs-fixed">
<h3>Bugs Fixed<a class="headerlink" href="#bugs-fixed" title="Permalink to this headline"></a></h3>
<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>
<p>In this release 5 issue were closed.</p>
</div>
</div>
<div class="section" id="version-0-2-0-statistics-2019-07-07"> <div class="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> <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="issues-closed"> <div class="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>
<div class="section" id="new-features"> <div class="section" id="id1">
<h4>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h4> <h4>New Features<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/13">#13</a> - Detailed statistics</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/Fittrackee/issues/13">#13</a> - Detailed statistics</p></li>
</ul> </ul>
@@ -165,17 +189,17 @@
</div> </div>
<div class="section" id="version-0-1-1-fix-and-improvements-2019-02-07"> <div class="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> <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="id1">
<h3>Issues Closed<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<div class="section" id="id2"> <div class="section" id="id2">
<h4>New Features<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h4> <h3>Issues Closed<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="section" id="id3">
<h4>New Features<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h4>
<ul class="simple"> <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/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> <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> </ul>
</div> </div>
<div class="section" id="bugs-fixed"> <div class="section" id="id4">
<h4>Bugs Fixed<a class="headerlink" href="#bugs-fixed" title="Permalink to this headline"></a></h4> <h4>Bugs Fixed<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h4>
<ul class="simple"> <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> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/31">#31</a> - Use moving duration for stats</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/29">#29</a> - Pause duration calculation with segments</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/29">#29</a> - Pause duration calculation with segments</p></li>
@@ -187,12 +211,12 @@
</div> </div>
</div> </div>
</div> </div>
<div class="section" id="version-0-1-0-minimal-version-2018-07-04"> <div class="section" id="version-0-1-minimal-version-2018-07-04">
<h2>Version 0.1.0 - Minimal version (2018-07-04)<a class="headerlink" href="#version-0-1-0-minimal-version-2018-07-04" title="Permalink to this headline"></a></h2> <h2>Version 0.1 - Minimal version (2018-07-04)<a class="headerlink" href="#version-0-1-minimal-version-2018-07-04" title="Permalink to this headline"></a></h2>
<div class="section" id="id3"> <div class="section" id="id5">
<h3>Issues Closed<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3> <h3>Issues Closed<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<div class="section" id="id4"> <div class="section" id="id6">
<h4>New Features<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h4> <h4>New Features<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h4>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/11">#11</a> - Timezone support</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/11">#11</a> - Timezone support</p></li>
<li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/10">#10</a> - Add a note to an activity</p></li> <li><p><a class="reference external" href="https://github.com/SamR1/FitTrackee/issues/10">#10</a> - Add a note to an activity</p></li>

22
docs/features.html
View File

@@ -75,7 +75,11 @@
role="menu" role="menu"
aria-labelledby="dLabelLocalToc"><ul> aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Features</a><ul> <li><a class="reference internal" href="#">Features</a><ul>
<li><a class="reference internal" href="#list">List</a></li> <li><a class="reference internal" href="#list">List</a><ul>
<li><a class="reference internal" href="#users">Users</a></li>
<li><a class="reference internal" href="#activities-workouts">Activities/Workouts</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dashboard">Dashboard</a></li> <li><a class="reference internal" href="#dashboard">Dashboard</a></li>
<li><a class="reference internal" href="#activity-workout-detail">Activity/workout detail</a></li> <li><a class="reference internal" href="#activity-workout-detail">Activity/workout detail</a></li>
<li><a class="reference internal" href="#activities-workouts-list">Activities/workouts list</a></li> <li><a class="reference internal" href="#activities-workouts-list">Activities/workouts list</a></li>
@@ -133,8 +137,16 @@
<h1>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1> <h1>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h1>
<div class="section" id="list"> <div class="section" id="list">
<h2>List<a class="headerlink" href="#list" title="Permalink to this headline"></a></h2> <h2>List<a class="headerlink" href="#list" title="Permalink to this headline"></a></h2>
<div class="section" id="users">
<h3>Users<a class="headerlink" href="#users" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Account creation (only standard user, not admin)</p></li> <li><p>Account creation (only standard user, not admin)</p></li>
<li><p>User registration can be disabled</p></li>
</ul>
</div>
<div class="section" id="activities-workouts">
<h3>Activities/Workouts<a class="headerlink" href="#activities-workouts" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><dl class="simple"> <li><dl class="simple">
<dt>6 sports supported:</dt><dd><ul> <dt>6 sports supported:</dt><dd><ul>
<li><p>Cycling (Sport)</p></li> <li><p>Cycling (Sport)</p></li>
@@ -147,10 +159,10 @@
</dd> </dd>
</dl> </dl>
</li> </li>
<li><p>Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)</p></li>
<li><p>An activity with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation)</p></li>
<li><p>Activity edition and deletion. User can add a note</p></li>
<li><p>Dashboard with month calendar displaying activities and record</p></li> <li><p>Dashboard with month calendar displaying activities and record</p></li>
<li><p>Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)</p></li>
<li><p>An activity with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed</p></li>
<li><p>Activity edition and deletion. User can add a note</p></li>
<li><p>User statistics</p></li> <li><p>User statistics</p></li>
<li><dl class="simple"> <li><dl class="simple">
<dt>User records by sports:</dt><dd><ul> <dt>User records by sports:</dt><dd><ul>
@@ -163,7 +175,6 @@
</dl> </dl>
</li> </li>
<li><p>Activities list and filter</p></li> <li><p>Activities list and filter</p></li>
<li><p>User registration can be disabled.</p></li>
</ul> </ul>
<p><strong>Notes:</strong></p> <p><strong>Notes:</strong></p>
<ul class="simple"> <ul class="simple">
@@ -171,6 +182,7 @@
<li><p>no administration for now</p></li> <li><p>no administration for now</p></li>
</ul> </ul>
</div> </div>
</div>
<div class="section" id="dashboard"> <div class="section" id="dashboard">
<h2>Dashboard<a class="headerlink" href="#dashboard" title="Permalink to this headline"></a></h2> <h2>Dashboard<a class="headerlink" href="#dashboard" title="Permalink to this headline"></a></h2>
<div class="figure align-default"> <div class="figure align-default">

3
docs/index.html
View File

@@ -182,9 +182,10 @@ 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-2-1-2019-xx-xx">Version 0.2.1 (2019/xx/xx)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-0-statistics-2019-07-07">Version 0.2.0 - Statistics (2019/07/07)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-0-statistics-2019-07-07">Version 0.2.0 - Statistics (2019/07/07)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-1-fix-and-improvements-2019-02-07">Version 0.1.1 - Fix and improvements (2019/02/07)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-1-fix-and-improvements-2019-02-07">Version 0.1.1 - Fix and improvements (2019/02/07)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-0-minimal-version-2018-07-04">Version 0.1.0 - Minimal version (2018-07-04)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-1-minimal-version-2018-07-04">Version 0.1 - Minimal version (2018-07-04)</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

52
docsrc/source/changelog.md
View File

@@ -1,52 +0,0 @@
# Change log
## Version 0.2.0 - Statistics (2019/07/07)
### Issues Closed
#### New Features
* [#13](https://github.com/SamR1/Fittrackee/issues/13) - Detailed statistics
#### Misc
* Update dependencies
In this release 1 issue was closed.
## Version 0.1.1 - Fix and improvements (2019/02/07)
### Issues Closed
#### New Features
* [#25](https://github.com/SamR1/FitTrackee/issues/25) - Display records on calendar
* [#22](https://github.com/SamR1/FitTrackee/issues/22) - Add a total on current month statistics
#### Bugs Fixed
* [#31](https://github.com/SamR1/FitTrackee/issues/31) - Use moving duration for stats
* [#29](https://github.com/SamR1/FitTrackee/issues/29) - Pause duration calculation with segments
* [#28](https://github.com/SamR1/FitTrackee/issues/28) - Error on uploading gpx file
* [#26](https://github.com/SamR1/FitTrackee/issues/26) - Total is incorrect in tooltip when duration is displayed
* [#24](https://github.com/SamR1/FitTrackee/issues/24) - Some distances are not displayed correctly on current month statistics
In this release 7 issues were closed.
## Version 0.1.0 - Minimal version (2018-07-04)
### Issues Closed
#### New Features
* [#11](https://github.com/SamR1/FitTrackee/issues/11) - Timezone support
* [#10](https://github.com/SamR1/FitTrackee/issues/10) - Add a note to an activity
* [#9](https://github.com/SamR1/FitTrackee/issues/9) - User statistics on dashboard
* [#8](https://github.com/SamR1/FitTrackee/issues/8) - Add weather to activities
* [#3](https://github.com/SamR1/FitTrackee/issues/3) - Search filter for activities
* [#2](https://github.com/SamR1/FitTrackee/issues/2) - Calendar to view activities
In this release 6 issues were closed.

1
docsrc/source/changelog.md Symbolic link
View File

@@ -0,0 +1 @@
../../CHANGELOG.md

14
docsrc/source/features.rst
View File

@@ -3,7 +3,14 @@ Features
List List
~~~~ ~~~~
Users
^^^^^
- Account creation (only standard user, not admin) - Account creation (only standard user, not admin)
- User registration can be disabled
Activities/Workouts
^^^^^^^^^^^^^^^^^^^
- 6 sports supported: - 6 sports supported:
- Cycling (Sport) - Cycling (Sport)
- Cycling (Transport) - Cycling (Transport)
@@ -11,10 +18,10 @@ List
- Montain Biking - Montain Biking
- Running - Running
- Walking - Walking
- Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)
- An activity with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation)
- Activity edition and deletion. User can add a note
- Dashboard with month calendar displaying activities and record - Dashboard with month calendar displaying activities and record
- Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)
- An activity with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed
- Activity edition and deletion. User can add a note
- User statistics - User statistics
- User records by sports: - User records by sports:
- average speed - average speed
@@ -22,7 +29,6 @@ List
- longest duration - longest duration
- maximum speed - maximum speed
- Activities list and filter - Activities list and filter
- User registration can be disabled.
**Notes:** **Notes:**