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-07-16 19:33:32 +02:00
parent 3c4718cc27
commit 99cfd72323
6 changed files with 58 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/_sources/installation.rst.txt
View File

@@ -84,14 +84,14 @@ deployment method.
:default: 1 :default: 1
.. envvar:: APP_LOG 🆕 .. envvar:: APP_LOG
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
Path to log file Path to log file
.. envvar:: UPLOAD_FOLDER 🆕 .. envvar:: UPLOAD_FOLDER
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
@@ -112,7 +112,7 @@ deployment method.
| Since `SQLAlchemy update (1.4+) <https://docs.sqlalchemy.org/en/14/changelog/changelog_14.html#change-3687655465c25a39b968b4f5f6e9170b>`__, | Since `SQLAlchemy update (1.4+) <https://docs.sqlalchemy.org/en/14/changelog/changelog_14.html#change-3687655465c25a39b968b4f5f6e9170b>`__,
engine URL should begin with `postgresql://`. engine URL should begin with `postgresql://`.
.. envvar:: DATABASE_DISABLE_POOLING 🆕 .. envvar:: DATABASE_DISABLE_POOLING
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
@@ -156,17 +156,17 @@ deployment method.
Number of processes used by **Dramatiq**. Number of processes used by **Dramatiq**.
.. envvar:: TILE_SERVER_URL 🆕 .. envvar:: TILE_SERVER_URL
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
| Tile server URL (with api key if needed), see `Map tile server <installation.html#map-tile-server>`__. | Tile server URL (with api key if needed), see `Map tile server <installation.html#map-tile-server>`__.
| Since **0.4.9**, it's also used to generate static maps. | Since **0.4.9**, it's also used to generate static maps (to keep default server, see `DEFAULT_STATICMAP <installation.html#envvar-DEFAULT_STATICMAP>`__)
:default: `https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png` :default: `https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png`
.. envvar:: MAP_ATTRIBUTION 🆕 .. envvar:: MAP_ATTRIBUTION
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
@@ -175,6 +175,15 @@ deployment method.
:default: `&copy; <a href="http://www.openstreetmap.org/copyright" target="_blank" rel="noopener noreferrer">OpenStreetMap</a> contributors` :default: `&copy; <a href="http://www.openstreetmap.org/copyright" target="_blank" rel="noopener noreferrer">OpenStreetMap</a> contributors`
.. envvar:: DEFAULT_STATICMAP 🆕
.. versionadded:: 0.4.9
If `True`, it keeps using default tile server to generate static maps.
:default: False
.. envvar:: WEATHER_API_KEY .. envvar:: WEATHER_API_KEY
.. versionchanged:: 0.4.0 ⚠️ replaces ``WEATHER_API`` .. versionchanged:: 0.4.0 ⚠️ replaces ``WEATHER_API``

12
docs/genindex.html
View File

@@ -121,7 +121,7 @@
environment variable environment variable
<ul> <ul>
<li><a href="installation.html#envvar-APP_LOG">APP_LOG 🆕</a> <li><a href="installation.html#envvar-APP_LOG">APP_LOG</a>
</li> </li>
<li><a href="installation.html#envvar-APP_SECRET_KEY">APP_SECRET_KEY</a> <li><a href="installation.html#envvar-APP_SECRET_KEY">APP_SECRET_KEY</a>
</li> </li>
@@ -129,9 +129,11 @@
</li> </li>
<li><a href="installation.html#envvar-APP_WORKERS">APP_WORKERS</a> <li><a href="installation.html#envvar-APP_WORKERS">APP_WORKERS</a>
</li> </li>
<li><a href="installation.html#envvar-DATABASE_DISABLE_POOLING">DATABASE_DISABLE_POOLING 🆕</a> <li><a href="installation.html#envvar-DATABASE_DISABLE_POOLING">DATABASE_DISABLE_POOLING</a>
</li> </li>
<li><a href="installation.html#envvar-DATABASE_URL">DATABASE_URL</a> <li><a href="installation.html#envvar-DATABASE_URL">DATABASE_URL</a>
</li>
<li><a href="installation.html#envvar-DEFAULT_STATICMAP">DEFAULT_STATICMAP 🆕</a>
</li> </li>
<li><a href="installation.html#envvar-EMAIL_URL">EMAIL_URL</a> <li><a href="installation.html#envvar-EMAIL_URL">EMAIL_URL</a>
</li> </li>
@@ -139,7 +141,7 @@
</li> </li>
<li><a href="installation.html#envvar-HOST">HOST</a> <li><a href="installation.html#envvar-HOST">HOST</a>
</li> </li>
<li><a href="installation.html#envvar-MAP_ATTRIBUTION">MAP_ATTRIBUTION 🆕</a> <li><a href="installation.html#envvar-MAP_ATTRIBUTION">MAP_ATTRIBUTION</a>
</li> </li>
<li><a href="installation.html#envvar-PORT">PORT</a> <li><a href="installation.html#envvar-PORT">PORT</a>
</li> </li>
@@ -159,11 +161,11 @@
</li> </li>
<li><a href="installation.html#envvar-SENDER_EMAIL">SENDER_EMAIL</a> <li><a href="installation.html#envvar-SENDER_EMAIL">SENDER_EMAIL</a>
</li> </li>
<li><a href="installation.html#envvar-TILE_SERVER_URL">TILE_SERVER_URL 🆕</a> <li><a href="installation.html#envvar-TILE_SERVER_URL">TILE_SERVER_URL</a>
</li> </li>
<li><a href="installation.html#envvar-UI_URL">UI_URL</a> <li><a href="installation.html#envvar-UI_URL">UI_URL</a>
</li> </li>
<li><a href="installation.html#envvar-UPLOAD_FOLDER">UPLOAD_FOLDER 🆕</a> <li><a href="installation.html#envvar-UPLOAD_FOLDER">UPLOAD_FOLDER</a>
</li> </li>
<li><a href="installation.html#envvar-WEATHER_API_KEY">WEATHER_API_KEY</a> <li><a href="installation.html#envvar-WEATHER_API_KEY">WEATHER_API_KEY</a>
</li> </li>

26
docs/installation.html
View File

@@ -274,7 +274,7 @@ deployment method.</p>
<dl class="std envvar"> <dl class="std envvar">
<dt id="envvar-APP_LOG"> <dt id="envvar-APP_LOG">
<span id="envvar-APP_LOG 🆕"></span><code class="sig-name descname"><span class="pre">APP_LOG</span> <span class="pre">🆕</span></code><a class="headerlink" href="#envvar-APP_LOG" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">APP_LOG</span></code><a class="headerlink" href="#envvar-APP_LOG" title="Permalink to this definition"></a></dt>
<dd><div class="versionadded"> <dd><div class="versionadded">
<p><span class="versionmodified added">New in version 0.4.0.</span></p> <p><span class="versionmodified added">New in version 0.4.0.</span></p>
</div> </div>
@@ -283,7 +283,7 @@ deployment method.</p>
<dl class="std envvar"> <dl class="std envvar">
<dt id="envvar-UPLOAD_FOLDER"> <dt id="envvar-UPLOAD_FOLDER">
<span id="envvar-UPLOAD_FOLDER 🆕"></span><code class="sig-name descname"><span class="pre">UPLOAD_FOLDER</span> <span class="pre">🆕</span></code><a class="headerlink" href="#envvar-UPLOAD_FOLDER" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">UPLOAD_FOLDER</span></code><a class="headerlink" href="#envvar-UPLOAD_FOLDER" title="Permalink to this definition"></a></dt>
<dd><div class="versionadded"> <dd><div class="versionadded">
<p><span class="versionmodified added">New in version 0.4.0.</span></p> <p><span class="versionmodified added">New in version 0.4.0.</span></p>
</div> </div>
@@ -320,7 +320,7 @@ engine URL should begin with <cite>postgresql://</cite>.</div>
<dl class="std envvar"> <dl class="std envvar">
<dt id="envvar-DATABASE_DISABLE_POOLING"> <dt id="envvar-DATABASE_DISABLE_POOLING">
<span id="envvar-DATABASE_DISABLE_POOLING 🆕"></span><code class="sig-name descname"><span class="pre">DATABASE_DISABLE_POOLING</span> <span class="pre">🆕</span></code><a class="headerlink" href="#envvar-DATABASE_DISABLE_POOLING" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">DATABASE_DISABLE_POOLING</span></code><a class="headerlink" href="#envvar-DATABASE_DISABLE_POOLING" title="Permalink to this definition"></a></dt>
<dd><div class="versionadded"> <dd><div class="versionadded">
<p><span class="versionmodified added">New in version 0.4.0.</span></p> <p><span class="versionmodified added">New in version 0.4.0.</span></p>
</div> </div>
@@ -382,13 +382,13 @@ see <a class="reference external" href="https://docs.sqlalchemy.org/en/13/core/p
<dl class="std envvar"> <dl class="std envvar">
<dt id="envvar-TILE_SERVER_URL"> <dt id="envvar-TILE_SERVER_URL">
<span id="envvar-TILE_SERVER_URL 🆕"></span><code class="sig-name descname"><span class="pre">TILE_SERVER_URL</span> <span class="pre">🆕</span></code><a class="headerlink" href="#envvar-TILE_SERVER_URL" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">TILE_SERVER_URL</span></code><a class="headerlink" href="#envvar-TILE_SERVER_URL" title="Permalink to this definition"></a></dt>
<dd><div class="versionadded"> <dd><div class="versionadded">
<p><span class="versionmodified added">New in version 0.4.0.</span></p> <p><span class="versionmodified added">New in version 0.4.0.</span></p>
</div> </div>
<div class="line-block"> <div class="line-block">
<div class="line">Tile server URL (with api key if needed), see <a class="reference external" href="installation.html#map-tile-server">Map tile server</a>.</div> <div class="line">Tile server URL (with api key if needed), see <a class="reference external" href="installation.html#map-tile-server">Map tile server</a>.</div>
<div class="line">Since <strong>0.4.9</strong>, it’s also used to generate static maps.</div> <div class="line">Since <strong>0.4.9</strong>, it’s also used to generate static maps (to keep default server, see <a class="reference external" href="installation.html#envvar-DEFAULT_STATICMAP">DEFAULT_STATICMAP</a>)</div>
</div> </div>
<dl class="field-list simple"> <dl class="field-list simple">
<dt class="field-odd">Default</dt> <dt class="field-odd">Default</dt>
@@ -399,7 +399,7 @@ see <a class="reference external" href="https://docs.sqlalchemy.org/en/13/core/p
<dl class="std envvar"> <dl class="std envvar">
<dt id="envvar-MAP_ATTRIBUTION"> <dt id="envvar-MAP_ATTRIBUTION">
<span id="envvar-MAP_ATTRIBUTION 🆕"></span><code class="sig-name descname"><span class="pre">MAP_ATTRIBUTION</span> <span class="pre">🆕</span></code><a class="headerlink" href="#envvar-MAP_ATTRIBUTION" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">MAP_ATTRIBUTION</span></code><a class="headerlink" href="#envvar-MAP_ATTRIBUTION" title="Permalink to this definition"></a></dt>
<dd><div class="versionadded"> <dd><div class="versionadded">
<p><span class="versionmodified added">New in version 0.4.0.</span></p> <p><span class="versionmodified added">New in version 0.4.0.</span></p>
</div> </div>
@@ -411,6 +411,20 @@ see <a class="reference external" href="https://docs.sqlalchemy.org/en/13/core/p
</dl> </dl>
</dd></dl> </dd></dl>
<dl class="std envvar">
<dt id="envvar-DEFAULT_STATICMAP">
<span id="envvar-DEFAULT_STATICMAP 🆕"></span><code class="sig-name descname"><span class="pre">DEFAULT_STATICMAP</span> <span class="pre">🆕</span></code><a class="headerlink" href="#envvar-DEFAULT_STATICMAP" title="Permalink to this definition"></a></dt>
<dd><div class="versionadded">
<p><span class="versionmodified added">New in version 0.4.9.</span></p>
</div>
<p>If <cite>True</cite>, it keeps using default tile server to generate static maps.</p>
<dl class="field-list simple">
<dt class="field-odd">Default</dt>
<dd class="field-odd"><p>False</p>
</dd>
</dl>
</dd></dl>
<dl class="std envvar"> <dl class="std envvar">
<dt id="envvar-WEATHER_API_KEY"> <dt id="envvar-WEATHER_API_KEY">
<code class="sig-name descname"><span class="pre">WEATHER_API_KEY</span></code><a class="headerlink" href="#envvar-WEATHER_API_KEY" title="Permalink to this definition"></a></dt> <code class="sig-name descname"><span class="pre">WEATHER_API_KEY</span></code><a class="headerlink" href="#envvar-WEATHER_API_KEY" title="Permalink to this definition"></a></dt>

BIN
docs/objects.inv
View File

Binary file not shown.

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

21
docsrc/source/installation.rst
View File

@@ -84,14 +84,14 @@ deployment method.
:default: 1 :default: 1
.. envvar:: APP_LOG 🆕 .. envvar:: APP_LOG
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
Path to log file Path to log file
.. envvar:: UPLOAD_FOLDER 🆕 .. envvar:: UPLOAD_FOLDER
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
@@ -112,7 +112,7 @@ deployment method.
| Since `SQLAlchemy update (1.4+) <https://docs.sqlalchemy.org/en/14/changelog/changelog_14.html#change-3687655465c25a39b968b4f5f6e9170b>`__, | Since `SQLAlchemy update (1.4+) <https://docs.sqlalchemy.org/en/14/changelog/changelog_14.html#change-3687655465c25a39b968b4f5f6e9170b>`__,
engine URL should begin with `postgresql://`. engine URL should begin with `postgresql://`.
.. envvar:: DATABASE_DISABLE_POOLING 🆕 .. envvar:: DATABASE_DISABLE_POOLING
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
@@ -156,17 +156,17 @@ deployment method.
Number of processes used by **Dramatiq**. Number of processes used by **Dramatiq**.
.. envvar:: TILE_SERVER_URL 🆕 .. envvar:: TILE_SERVER_URL
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
| Tile server URL (with api key if needed), see `Map tile server <installation.html#map-tile-server>`__. | Tile server URL (with api key if needed), see `Map tile server <installation.html#map-tile-server>`__.
| Since **0.4.9**, it's also used to generate static maps. | Since **0.4.9**, it's also used to generate static maps (to keep default server, see `DEFAULT_STATICMAP <installation.html#envvar-DEFAULT_STATICMAP>`__)
:default: `https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png` :default: `https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png`
.. envvar:: MAP_ATTRIBUTION 🆕 .. envvar:: MAP_ATTRIBUTION
.. versionadded:: 0.4.0 .. versionadded:: 0.4.0
@@ -175,6 +175,15 @@ deployment method.
:default: `&copy; <a href="http://www.openstreetmap.org/copyright" target="_blank" rel="noopener noreferrer">OpenStreetMap</a> contributors` :default: `&copy; <a href="http://www.openstreetmap.org/copyright" target="_blank" rel="noopener noreferrer">OpenStreetMap</a> contributors`
.. envvar:: DEFAULT_STATICMAP 🆕
.. versionadded:: 0.4.9
If `True`, it keeps using default tile server to generate static maps.
:default: False
.. envvar:: WEATHER_API_KEY .. envvar:: WEATHER_API_KEY
.. versionchanged:: 0.4.0 ⚠️ replaces ``WEATHER_API`` .. versionchanged:: 0.4.0 ⚠️ replaces ``WEATHER_API``