feat(doc): complete admin doc

PnX-SI · Nov 20, 2024 · eb300df · eb300df
1 parent d57f95c
commit eb300df
Show file tree

Hide file tree

Showing 6 changed files with 102 additions and 65 deletions.
diff --git a/docs/_static/import/importderoulement.png b/docs/_static/import/importderoulement.png
diff --git a/docs/admin/import_admin.rst b/docs/admin/import_admin.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -54,7 +54,11 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_suffix = [".rst", ".md"]
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".txt": "markdown",
+    ".md": "markdown",
+}
 
 # The master toctree document.
 master_doc = "index"
@@ -104,18 +108,7 @@
 # documentation.
 #
 html_theme_options = {
-    # "canonical_url": "",
-    # "logo_only": False,
-    # "display_version": True,
-    # "prev_next_buttons_location": "bottom",
-    # "style_external_links": False,
-    # "style_nav_header_background": "white",
-    # # Toc options
-    # "collapse_navigation": True,
-    # "sticky_navigation": True,
     "navigation_depth": 3,
-    # "includehidden": True,
-    # "titles_only": False,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

diff --git a/docs/images/import/import_modele.png b/docs/images/import/import_modele.png
diff --git a/docs/images/import/importderoulement.png b/docs/images/import/importderoulement.png
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -282,15 +282,15 @@ La mise à jour doit être réalisée avec votre utilisateur linux courant (``ge
 
 * Télécharger la dernière version de GeoNature :
 
-  ::
+.. code-block:: bash
 
     wget https://github.com/PnX-SI/GeoNature/archive/X.Y.Z.zip
     unzip X.Y.Z.zip
     rm X.Y.Z.zip
 
 * Renommer l'ancien repertoire de l'application, ainsi que le nouveau :
 
-  ::
+.. code-block:: bash
 
     mv ~/geonature/ ~/geonature_old/
     mv ~/GeoNature-X.Y.Z ~/geonature/
@@ -304,18 +304,19 @@ Sauf mentions contraires dans les notes de version, vous pouvez sauter des versi
 
 * Lancez le script de ``migration.sh`` à la racine du dossier ``geonature``:
 
-::
-  ./install/migration/migration.sh 2>&1 | tee install/migration/migration.log
+.. code-block:: bash
+
+    ./install/migration/migration.sh 2>&1 | tee install/migration/migration.log
 
 Depuis la version 2.12, le script `migration.sh` peut prendre en argument le chemin vers l'ancien dossier d'installation de GeoNature. Il peut s’agir du même dossier que la nouvelle installation de GeoNature. Cela permet d'utiliser ce script si la nouvelle version de GeoNature est dans le même dossier et donc de gérer le cas où GeoNature est installé et mis à jour avec git.
 
 Dans ce cas, les commandes à exécuter sont : 
 
-::
-  
-  cd ~/GeoNature
-  git status # optionnel, pour connaitre l'état et la version ou branche actuellement utilisée
-  git fetch
-  git checkout X.Y.Z # où X.Y.Z est le numéro du tag de la version vers laquelle faire la mise à jour, ou le nom de la branche à utiliser
-  git submodule update # ou "git config submodule.recurse true" lancé une seule fois, pour que la mise à jour des sous-modules soit relancée automatiquement à chaque "git pull"
-  ./install/migration/migration.sh .
+.. code-block:: bash
+
+    cd ~/GeoNature
+    git status # optionnel, pour connaitre l'état et la version ou branche actuellement utilisée
+    git fetch
+    git checkout X.Y.Z # où X.Y.Z est le numéro du tag de la version vers laquelle faire la mise à jour, ou le nom de la branche à utiliser
+    git submodule update # ou "git config submodule.recurse true" lancé une seule fois, pour que la mise à jour des sous-modules soit relancée automatiquement à chaque "git pull"
+    ./install/migration/migration.sh .