From ea3fc6aafa13584f03354795282bf7bf9cd8c6cd Mon Sep 17 00:00:00 2001 From: Sam Date: Sun, 25 Aug 2019 21:21:34 +0200 Subject: [PATCH] update documentation --- CHANGELOG.md | 4 ++- docs/_sources/changelog.md.txt | 19 ++++++++-- docs/_sources/features.rst.txt | 14 +++++--- docs/changelog.html | 64 +++++++++++++++++++++++----------- docs/features.html | 22 +++++++++--- docs/index.html | 3 +- docs/searchindex.js | 2 +- docsrc/source/changelog.md | 53 +--------------------------- docsrc/source/features.rst | 14 +++++--- 9 files changed, 105 insertions(+), 90 deletions(-) mode change 100644 => 120000 docsrc/source/changelog.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 41913187..4c1c20e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ #### 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 @@ -11,7 +13,7 @@ * [#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) diff --git a/docs/_sources/changelog.md.txt b/docs/_sources/changelog.md.txt index 6aed3059..4c1c20e6 100644 --- a/docs/_sources/changelog.md.txt +++ b/docs/_sources/changelog.md.txt @@ -1,5 +1,21 @@ # 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) ### 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 * [#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) +## Version 0.1 - Minimal version (2018-07-04) ### Issues Closed diff --git a/docs/_sources/features.rst.txt b/docs/_sources/features.rst.txt index dea672ad..53f999b9 100644 --- a/docs/_sources/features.rst.txt +++ b/docs/_sources/features.rst.txt @@ -3,7 +3,14 @@ Features List ~~~~ + +Users +^^^^^ - Account creation (only standard user, not admin) +- User registration can be disabled + +Activities/Workouts +^^^^^^^^^^^^^^^^^^^ - 6 sports supported: - Cycling (Sport) - Cycling (Transport) @@ -11,10 +18,10 @@ List - Montain Biking - Running - 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 +- 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 records by sports: - average speed @@ -22,7 +29,6 @@ List - longest duration - maximum speed - Activities list and filter -- User registration can be disabled. **Notes:** diff --git a/docs/changelog.html b/docs/changelog.html index 218d3e49..4557563f 100644 --- a/docs/changelog.html +++ b/docs/changelog.html @@ -74,25 +74,30 @@ role="menu" aria-labelledby="dLabelLocalToc">