update documentation

2022-07-13 13:02:12 +02:00 · 2022-07-13 13:02:12 +02:00 · cb70e8c458
commit cb70e8c458
parent 6e53e4f3bf
6 changed files with 108 additions and 8 deletions
--- a/docs/_sources/installation.rst.txt
+++ b/docs/_sources/installation.rst.txt
@ -175,6 +175,16 @@ deployment method.
    :default: `https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png`


+.. envvar:: STATICMAP_SUBDOMAINS 🆕
+
+    .. versionadded:: 0.6.10
+
+    | Some tile servers require a subdomain, see `Map tile server <installation.html#map-tile-server>`__.
+    | For instance: "a,b,c" for OSM France.
+
+    :default: empty string
+
+
 .. envvar:: MAP_ATTRIBUTION

    .. versionadded:: 0.4.0
@ -184,11 +194,17 @@ deployment method.
    :default: `&copy; <a href="http://www.openstreetmap.org/copyright" target="_blank" rel="noopener noreferrer">OpenStreetMap</a> contributors`


-.. envvar:: DEFAULT_STATICMAP 🆕
+.. envvar:: DEFAULT_STATICMAP

    .. versionadded:: 0.4.9

-    If `True`, it keeps using default tile server to generate static maps.
+    | If `True`, it keeps using default tile server to generate static maps (Komoot.de tile server).
+    | Otherwise, it uses the tile server set in `TILE_SERVER_URL <installation.html#envvar-TILE_SERVER_URL>`__.
+
+    .. versionchanged:: 0.6.10
+
+    | This variable is now case-insensitive.
+    | If `False`, depending on tile server, `subdomains <installation.html#envvar-STATICMAP_SUBDOMAINS>`__ may be mandatory.

    :default: False

@ -256,6 +272,20 @@ To keep using **ThunderForest Outdoors**, the configuration is:
 .. note::
    | Check the terms of service of tile provider for map attribution

+
+.. versionchanged:: 0.6.10
+
+Since the tile server can be used for static map generation, some servers require a subdomain.
+
+For instance, to set OSM France tile server, the expected values are:
+
+- ``TILE_SERVER_URL=https://{s}.tile.openstreetmap.fr/osmfr/{z}/{x}/{y}.png``
+- ``MAP_ATTRIBUTION=fond de carte par <a href="http://www.openstreetmap.fr/mentions-legales/" target="_blank" rel="nofollow noopener">OpenStreetMap France</a>, sous&nbsp;<a href="http://creativecommons.org/licenses/by-sa/2.0/fr/" target="_blank" rel="nofollow noopener">licence CC BY-SA</a>``
+- ``STATICMAP_SUBDOMAINS=a,b,c``
+
+The subdomain will be chosen randomly.
+
+
 Installation
 ~~~~~~~~~~~~

--- a/docs/genindex.html
+++ b/docs/genindex.html
@ -135,7 +135,7 @@
 </li>
        <li><a href="installation.html#envvar-DATABASE_URL">DATABASE_URL</a>
 </li>
-        <li><a href="installation.html#envvar-DEFAULT_STATICMAP">DEFAULT_STATICMAP 🆕</a>
+        <li><a href="installation.html#envvar-DEFAULT_STATICMAP">DEFAULT_STATICMAP</a>
 </li>
        <li><a href="installation.html#envvar-EMAIL_URL">EMAIL_URL</a>
 </li>
@ -150,6 +150,8 @@
        <li><a href="installation.html#envvar-REDIS_URL">REDIS_URL</a>
 </li>
        <li><a href="installation.html#envvar-SENDER_EMAIL">SENDER_EMAIL</a>
+</li>
+        <li><a href="installation.html#envvar-STATICMAP_SUBDOMAINS">STATICMAP_SUBDOMAINS 🆕</a>
 </li>
        <li><a href="installation.html#envvar-TILE_SERVER_URL">TILE_SERVER_URL</a>
 </li>
--- a/docs/installation.html
+++ b/docs/installation.html
@ -420,6 +420,23 @@ see <a class="reference external" href="https://docs.sqlalchemy.org/en/13/core/p
 </dl>
 </dd></dl>

+<dl class="std envvar">
+<dt class="sig sig-object std" id="envvar-STATICMAP_SUBDOMAINS">
+<span class="sig-name descname"><span class="pre">STATICMAP_SUBDOMAINS</span> <span class="pre">🆕</span></span><a class="headerlink" href="#envvar-STATICMAP_SUBDOMAINS" title="Permalink to this definition">¶</a></dt>
+<dd><div class="versionadded">
+<p><span class="versionmodified added">New in version 0.6.10.</span></p>
+</div>
+<div class="line-block">
+<div class="line">Some tile servers require a subdomain, see <a class="reference external" href="installation.html#map-tile-server">Map tile server</a>.</div>
+<div class="line">For instance: “a,b,c” for OSM France.</div>
+</div>
+<dl class="field-list simple">
+<dt class="field-odd">Default<span class="colon">:</span></dt>
+<dd class="field-odd"><p>empty string</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="std envvar">
 <dt class="sig sig-object std" id="envvar-MAP_ATTRIBUTION">
 <span class="sig-name descname"><span class="pre">MAP_ATTRIBUTION</span></span><a class="headerlink" href="#envvar-MAP_ATTRIBUTION" title="Permalink to this definition">¶</a></dt>
@ -436,11 +453,21 @@ see <a class="reference external" href="https://docs.sqlalchemy.org/en/13/core/p

 <dl class="std envvar">
 <dt class="sig sig-object std" id="envvar-DEFAULT_STATICMAP">
-<span class="sig-name descname"><span class="pre">DEFAULT_STATICMAP</span> <span class="pre">🆕</span></span><a class="headerlink" href="#envvar-DEFAULT_STATICMAP" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">DEFAULT_STATICMAP</span></span><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>
+<div class="line-block">
+<div class="line">If <cite>True</cite>, it keeps using default tile server to generate static maps (Komoot.de tile server).</div>
+<div class="line">Otherwise, it uses the tile server set in <a class="reference external" href="installation.html#envvar-TILE_SERVER_URL">TILE_SERVER_URL</a>.</div>
+</div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 0.6.10.</span></p>
+</div>
+<div class="line-block">
+<div class="line">This variable is now case-insensitive.</div>
+<div class="line">If <cite>False</cite>, depending on tile server, <a class="reference external" href="installation.html#envvar-STATICMAP_SUBDOMAINS">subdomains</a> may be mandatory.</div>
+</div>
 <dl class="field-list simple">
 <dt class="field-odd">Default<span class="colon">:</span></dt>
 <dd class="field-odd"><p>False</p>
@ -527,6 +554,17 @@ The tile server can be changed by updating <code class="docutils literal notrans
 <div class="line">Check the terms of service of tile provider for map attribution</div>
 </div>
 </div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 0.6.10.</span></p>
+</div>
+<p>Since the tile server can be used for static map generation, some servers require a subdomain.</p>
+<p>For instance, to set OSM France tile server, the expected values are:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">TILE_SERVER_URL=https://{s}.tile.openstreetmap.fr/osmfr/{z}/{x}/{y}.png</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">MAP_ATTRIBUTION=fond</span> <span class="pre">de</span> <span class="pre">carte</span> <span class="pre">par</span> <span class="pre">&lt;a</span> <span class="pre">href=&quot;http://www.openstreetmap.fr/mentions-legales/&quot;</span> <span class="pre">target=&quot;_blank&quot;</span> <span class="pre">rel=&quot;nofollow</span> <span class="pre">noopener&quot;&gt;OpenStreetMap</span> <span class="pre">France&lt;/a&gt;,</span> <span class="pre">sous&amp;nbsp;&lt;a</span> <span class="pre">href=&quot;http://creativecommons.org/licenses/by-sa/2.0/fr/&quot;</span> <span class="pre">target=&quot;_blank&quot;</span> <span class="pre">rel=&quot;nofollow</span> <span class="pre">noopener&quot;&gt;licence</span> <span class="pre">CC</span> <span class="pre">BY-SA&lt;/a&gt;</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">STATICMAP_SUBDOMAINS=a,b,c</span></code></p></li>
+</ul>
+<p>The subdomain will be chosen randomly.</p>
 </section>
 </section>
 <section id="id1">
--- a/docs/objects.inv
+++ b/docs/objects.inv
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
--- a/docsrc/source/installation.rst
+++ b/docsrc/source/installation.rst
@ -175,6 +175,16 @@ deployment method.
    :default: `https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png`


+.. envvar:: STATICMAP_SUBDOMAINS 🆕
+
+    .. versionadded:: 0.6.10
+
+    | Some tile servers require a subdomain, see `Map tile server <installation.html#map-tile-server>`__.
+    | For instance: "a,b,c" for OSM France.
+
+    :default: empty string
+
+
 .. envvar:: MAP_ATTRIBUTION

    .. versionadded:: 0.4.0
@ -184,11 +194,17 @@ deployment method.
    :default: `&copy; <a href="http://www.openstreetmap.org/copyright" target="_blank" rel="noopener noreferrer">OpenStreetMap</a> contributors`


-.. envvar:: DEFAULT_STATICMAP 🆕
+.. envvar:: DEFAULT_STATICMAP

    .. versionadded:: 0.4.9

-    If `True`, it keeps using default tile server to generate static maps.
+    | If `True`, it keeps using default tile server to generate static maps (Komoot.de tile server).
+    | Otherwise, it uses the tile server set in `TILE_SERVER_URL <installation.html#envvar-TILE_SERVER_URL>`__.
+
+    .. versionchanged:: 0.6.10
+
+    | This variable is now case-insensitive.
+    | If `False`, depending on tile server, `subdomains <installation.html#envvar-STATICMAP_SUBDOMAINS>`__ may be mandatory.

    :default: False

@ -256,6 +272,20 @@ To keep using **ThunderForest Outdoors**, the configuration is:
 .. note::
    | Check the terms of service of tile provider for map attribution

+
+.. versionchanged:: 0.6.10
+
+Since the tile server can be used for static map generation, some servers require a subdomain.
+
+For instance, to set OSM France tile server, the expected values are:
+
+- ``TILE_SERVER_URL=https://{s}.tile.openstreetmap.fr/osmfr/{z}/{x}/{y}.png``
+- ``MAP_ATTRIBUTION=fond de carte par <a href="http://www.openstreetmap.fr/mentions-legales/" target="_blank" rel="nofollow noopener">OpenStreetMap France</a>, sous&nbsp;<a href="http://creativecommons.org/licenses/by-sa/2.0/fr/" target="_blank" rel="nofollow noopener">licence CC BY-SA</a>``
+- ``STATICMAP_SUBDOMAINS=a,b,c``
+
+The subdomain will be chosen randomly.
+
+
 Installation
 ~~~~~~~~~~~~