update documentation

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

View File

@ -75,7 +75,11 @@
role="menu"
aria-labelledby="dLabelLocalToc"><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="#activity-workout-detail">Activity/workout detail</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>
<div class="section" id="list">
<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">
<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">
<dt>6 sports supported:</dt><dd><ul>
<li><p>Cycling (Sport)</p></li>
@ -147,10 +159,10 @@
</dd>
</dl>
</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>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><dl class="simple">
<dt>User records by sports:</dt><dd><ul>
@ -163,7 +175,6 @@
</dl>
</li>
<li><p>Activities list and filter</p></li>
<li><p>User registration can be disabled.</p></li>
</ul>
<p><strong>Notes:</strong></p>
<ul class="simple">
@ -171,6 +182,7 @@
<li><p>no administration for now</p></li>
</ul>
</div>
</div>
<div class="section" id="dashboard">
<h2>Dashboard<a class="headerlink" href="#dashboard" title="Permalink to this headline"></a></h2>
<div class="figure align-default">