Improve doc

docs/advanced-configuration/modules-and-components.rst

@@ -17,7 +17,6 @@ In order to disable a full set of modules, in the custom settings file, add the
     _INSTALLED_APPS.remove('geotrek.maintenance')
     INSTALLED_APPS = _INSTALLED_APPS
 
-
 TRAIL_MODEL_ENABLED
 ~~~~~~~~~~~~~~~~~~~~
 

docs/conf.py

@@ -29,6 +29,14 @@
 
 html_logo = "_static/logo.svg"
 
+sphinx_immaterial_custom_admonitions = [
+    {
+        "name": "legend",
+        "color": (142, 142, 142),
+        "icon": "fontawesome/solid/eye",
+    }
+]
+
 # Material theme options (see theme.conf for more information)
 html_theme_options = {
     "icon": {

docs/contribute/documentation.rst

@@ -10,7 +10,7 @@ To compile and test documentation on local environment, run:
 
 .. code-block:: bash
 
-    docker compose up -d sphinx
+    docker compose up sphinx postgres
 
 Access to documentation built in html : http://0.0.0.0:8800
 

docs/import-data/import-agregator.rst → docs/import-data/import-aggregator.rst

@@ -1,10 +1,10 @@
 ===============================
-From other Geotrek (agregator)
+From other Geotrek (aggregator)
 ===============================
 
 .. abstract:: Key words
 
-   ``Agregator``, ``Non dynamic segmentation``, ``parsers``, ``cron``
+   ``Aggregator``, ``parsers``, ``cron``
 
 
 .. _import-data-from-a-remote-geotrek-instance:

docs/import-data/import-dem-raster.rst

@@ -8,7 +8,8 @@ Refer to :ref:`this section <altimetry-dem-source-list>` to learn about the avai
 
 .. warning::
 
-    We recommend not importing a DEM with too precise resolution for performance reasons. For example, the BD Alti DEM with a 25m resolution is perfect to cover a department.
+    - We recommend not importing a DEM with too precise resolution for performance reasons. For example, the BD Alti DEM with a 25m resolution is perfect to cover a department.
+    - If you downloaded the BD Alti or RGE Alti, you will need to convert the ``.asc`` DEM to ``.tif`` format (e.g. with QGIS) before uploading it on the server.
 
 In `QGIS <http://docs.qgis.org/latest/en/docs/training_manual/processing/cutting_merging.html>`_,
 you can visualize your DEM, or merge several tiles together (in *Raster* > *Misc* > *Merge*).

docs/import-data/minimal-initial-data.rst

@@ -105,6 +105,8 @@ Districts
      - GeoJSON
      - Annually
 
+Districts are not necessarily administrative boundaries. They can be intercommunalities, departments, parks, or natural regions. The advantage of importing them as Districts is that you will be able to filter them in Geotrek-rando, which will not be possible with Restricted areas.
+
 .. seealso::
 
 	Refer to :ref:`this section <import-districts>` to learn more about loading districts in your Geotrek-admin.

docs/index.rst

@@ -84,7 +84,7 @@ You can explore **Geotrek-admin** in action through the demonstration website:
     import-data/import-areas
     import-data/import-touristic-data-systems
     import-data/import-other-data
-    import-data/import-agregator
+    import-data/import-aggregator
 
 .. toctree::
     :caption: ✨ Contribute

docs/user-manual/management-modules.rst

@@ -22,11 +22,11 @@ Lors de la saisie d'un objet sur la carte, il est possible d'afficher une couche
 Les tronçons
 ============
 
-.. task-list::
-    :class: custom-task-list-style
-    :custom:
+.. legend:: Bon à savoir
 
-    + [x] Segmentation dynamique
+      ✨ Disponible uniquement en segmentation dynamique
+
+      🗺️ Calcul reposant sur la segmentation dynamique lorsqu'elle est activée
 
 C'est le socle essentiel et central de Geotrek. Un tronçon est un objet linéaire, entre deux intersections. Le mécanisme de segmentation dynamique permet de ne pas devoir le recouper pour y rattacher des informations.
 

docs/user-manual/overview.rst

@@ -35,96 +35,88 @@ Modules de gestion
 -------------------
 
 .. list-table:: 
-   :widths: 25 25 50 25
+   :widths: 25 25 50
    :header-rows: 1
 
    * - Icône
      - Module
      - Description
-     - Segmentation dynamique
    * - .. figure:: ../images/user-manual/modules/troncons.png
           :alt: Tronçon
-     - :ref:`Tronçon <les-troncons>`
+     - :ref:`Tronçon <les-troncons>` ✨
      - | C'est l’équivalent du réseau routier : ils constituent le support des tracés
        | des objets linéaires (itinéraires, statuts, interventions, aménagements...). 
        | Leur modification est relativement rare (fermeture d’un chemin, 
        | éboulement...).
-     - ✅
    * - .. figure:: ../images/user-manual/modules/sentier.png
           :alt: Sentier
-     - :ref:`Sentier <les-sentiers>`
+     - :ref:`Sentier <les-sentiers>` ✨
      - | Les itinéraires, non pas de randonnée, mais de gestion, correspondent au 
        | départ et à l'arrivée d'un sentier.
-     - ✅
    * - .. figure:: ../images/user-manual/modules/statut.png
           :alt: Statut
-     - :ref:`Statut <les-statuts>`
+     - :ref:`Statut <les-statuts>` ✨
      - | Gestion des organismes ayant la compétence sentiers,  
        | gestionnaires des travaux et de la signalétique.  
        | Type physique (route, piste, sente, etc.)
-     - ✅
    * - .. figure:: ../images/user-manual/modules/amenagement.png
           :alt: Aménagement
-     - :ref:`Aménagement <les-amenagements>`
+     - :ref:`Aménagement <les-amenagements>` 🗺️
      - | Décrit et localise les ouvrages, le mobilier, les équipements.
-     - ✅
    * - .. figure:: ../images/user-manual/modules/signaletique.png
           :alt: Signalétique
-     - :ref:`Signalétique <la-signaletique>`
+     - :ref:`Signalétique <la-signaletique>` 🗺️
      - | Reprend l'ensemble de la signalétique d'accueil, d'information et 
        | d'orientation à destination des randonneurs.
        | Gestion des fichiers associés comme les BAT, les maquettes...
-     - ✅
    * - .. figure:: ../images/user-manual/modules/intervention.png
           :alt: Intervention
-     - :ref:`Intervention <les-interventions>`
+     - :ref:`Intervention <les-interventions>` 🗺️
      - | Répertorie les travaux liés à l'entretien courant des ouvrages,
        | l'entretien sur les sentiers, la mise en place et l'entretien 
        | de la signalétique, etc...
-     - ✅
    * - .. figure:: ../images/user-manual/modules/chantier.png
           :alt: Chantier
      - :ref:`Chantier <les-chantiers>`
      - | Correspond à des ensembles d'interventions. Cela permet d'avoir une 
        | approche globale de chantiers significatifs et des informations 
        | administratives associées.
-     - 
 
+.. legend:: Légende
 
+      ✨ : Disponible uniquement en segmentation dynamique
+
+      🗺️ : Calcul reposant sur la segmentation dynamique lorsqu'elle est activée
 
 Modules de valorisation
 ------------------------
 
 .. list-table:: 
-   :widths: 25 25 50 25
+   :widths: 25 25 50 
    :header-rows: 1
 
    * - Icône
      - Module
      - Description
-     - Segmentation dynamique
    * - .. figure:: ../images/user-manual/modules/itineraire.png
-     - :ref:`Itinéraire <itineraires>`
+     - :ref:`Itinéraire <itineraires>` 🗺️
      - | Randonnées présentées au grand public : l’itinéraire est 
        | défini selon la géométrie des tronçons empruntés. L’ajout, 
        | la modification sont fréquents. La dé-publication est fortement
        | déconseillée pour le référencement et les passerelles 
        | avec d'autres outils.
-     - ✅
    * - .. figure:: ../images/user-manual/modules/poi.png
-     - :ref:`Points d'intérêts (POI) <points-d-interets-poi>`
+     - :ref:`Points d'intérêts (POI) <points-d-interets-poi>` 🗺️
      - | Ponctuels à découvrir associés aux randonnées : en fonction 
        | de leur  emplacement, ils sont associés automatiquement aux 
        | randonnées. Leur catégorie détermine leur pictogramme (faune,  
        | flore, patrimoine, équipements...).
-     - ✅
    * - .. figure:: ../images/user-manual/modules/service.png
      - :ref:`Services <services>`
      - | Informations pratiques comme les points d'eau, passages 
        | délicats... selon la typologie souhaitée. Ils n'ont pas de 
        | description ni de nom, ni de photo et sont uniquement affichés 
        | sur la carte de l'itinéraire sous forme de pictogramme. 
-     - 
    * - .. figure:: ../images/user-manual/modules/contenustouristiques.png
      - :ref:`Contenus touristiques <contenus-touristiques>`
      - | Correspond aux services touristiques pouvant être importés 
@@ -133,37 +125,38 @@ Modules de valorisation
        | données Geotrek. Celles-ci sont regroupées dans des 
        | catégories de type : hébergements, musées, restaurants, 
        | produits du terroir...
-     - 
    * - .. figure:: ../images/user-manual/modules/evenementstouristiques.png
      - :ref:`Évènements touristiques <evenements-touristiques>`
      - | Correspond aux animations pouvant être importées depuis 
        | des Systèmes d'Informations Touristiques (SIT), qui permettent
        | d'alimenter automatiquement la base de données Geotrek. 
        | Celles-ci sont regroupées dans des catégories de type : 
        | conférences, expositions, sorties...
-     - 
    * - .. figure:: ../images/user-manual/modules/signalements.png
      - :ref:`Signalements <signalements>`
      - | Contient les problèmes remontés par les internautes, par 
        | exemple via le formulaire dédié sur Geotrek-rando
-     -
    * - .. figure:: ../images/user-manual/modules/zonessensibles.png
      - :ref:`Zones sensibles <zones-sensibles>`
      - | Module non activé par défaut permettant de saisir et de gérer  
        | des zones de sensibilité de la faune sauvage pour les afficher 
        | sur Geotrek-rando ou les diffuser avec l'API de Geotrek-admin).
-     - 
    * - .. figure:: ../images/user-manual/modules/sitesoutdoor.png
      - :ref:`Sites outdoor <pleinenature>`
      - | Permet de définir des sites d'activités de pleine nature 
        | (sites d'escalade, rivières, aires de vol libre)
-     -
    * - .. figure:: ../images/user-manual/modules/parcoursoutdoor.png
      - :ref:`Parcours outdoor <pleinenature>`
      - | Couplé au module « site outdoor», permet de les détailler en 
        | renseignant des activités de pleine nature diverses (kayak, 
        | rafting, parapente, course d'orientation, voie d'escalade, 
        | parcours d'eau vive…etc.) 
-     -
+
+.. legend:: Légende
+
+      ✨ : Disponible uniquement en segmentation dynamique
+
+      🗺️ : Calcul reposant sur la segmentation dynamique lorsqu'elle est activée
+
 
 Chaque module est accessible depuis le bandeau vertical situé à gauche de l'écran.