Merge pull request #32 from IGNF/feature/update_myst_substitutions

doc(define_repo): define repository and use myst substitution

documentation/conf.py

@@ -6,6 +6,7 @@
 
 # standard
 import sys
+import json
 from datetime import datetime
 from os import environ, path
 
@@ -14,6 +15,17 @@
 # -- Build environment -----------------------------------------------------
 on_rtd = environ.get("READTHEDOCS", None) == "True"
 
+# -- Project information -----------------------------------------------------
+f = open('../package.json')
+
+package_node = json.load(f)
+
+author = package_node["author"]
+description = package_node["description"]
+project = package_node["name"]
+version = package_node["version"]
+uri_repository = "https://github.com/IGNF/road2/"
+
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -66,6 +78,12 @@
 html_theme = "furo"
 html_title = "Road2 documentation"
 
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+html_search_language = "fr"
+
 # -- EXTENSIONS --------------------------------------------------------
 # MyST Parser
 myst_enable_extensions = [
@@ -81,13 +99,13 @@
 ]
 
 myst_substitutions = {
-    #"author": author,
+    "author": author,
     "date_update": datetime.now().strftime("%d %B %Y"),
-    #"description": description,
-    #"repo_url": __about__.__uri__,
-    #"title": project,
-    #"version": version,
-    #"license": license,
+    "description": description,    
+    "repo_branch": "develop",
+    "repo_url": uri_repository,
+    "title": project,
+    "version": version,
 }
 
 myst_url_schemes = ["http", "https", "mailto"]

documentation/configuration/readme.md

@@ -55,13 +55,13 @@ On peut trouver un [exemple](../../docker/config/projections/projection.json) de
 
 Dans les fichiers du type *service.json*, il est possible d'indiquer plusieurs dossiers *sources*. Chaque dossier sera lu et les fichiers `*.source` seront analysés par Road2. Chacun de ces fichiers représente une source pour Road2. 
 
-On peut trouver, dans ce [dossier](./sources/), un exemple de ce genre de fichier pour chaque type de source disponible dans le code de Road2.
+On peut trouver, dans {{ '[documentation/configuration/sources]({}/tree/{}/documentation/configuration/sources)'.format(repo_url, repo_branch) }}, un exemple de ce genre de fichier pour chaque type de source disponible dans le code de Road2.
 
 ## Les ressources 
 
 Dans les fichiers *service.json*, il peut également indiquer plusieurs dossiers *resources*. Chaque dossier sera lu et les fichiers `*.resource` seront analysés par Road2. Chacun de ces fichiers représente cette fois-ci une ressource pour Road2. 
 
-On peut trouver, dans ce [dossier](./resources/), un exemple de ce genre de fichier pour chaque type de ressource disponible dans le code de Road2. Chaque type suit le même modèle YAML. 
+On peut trouver, dans ce {{ '[documentation/configuration/resources]({}/tree/{}/documentation/configuration/resources)'.format(repo_url, repo_branch) }}, un exemple de ce genre de fichier pour chaque type de ressource disponible dans le code de Road2. Chaque type suit le même modèle YAML. 
 
 ## Les fichiers liés à certains moteurs de Road2
 

documentation/developers/concepts.md

@@ -14,7 +14,7 @@ C'est le concept de base pour comprendre le code de Road2.
 
 Par exemple, si on considère une API qui s'appelle `rest` qui ne possède qu'une seule version `1.0.0`. Dans cette API, on pourrait définir une seule route `compute` qui permet de demander un itinéraire avec les paramètres `start` et `end` au minimum. On parlera alors de l'API `rest/1.0.0` qui permet à un utilisateur d'obtenir un itinéraire en faisant la requête `/rest/1.0.0/compute?start=2,48&end=2,48.1`. 
 
-Chaque API est définie dans un dossier distinct des autres. Cela les rend indépendantes les unes des autres. Et pour une même appellation, on a une indépendance entre deux versions différentes. On trouvera des exemples d'implémentation dans le dossier des [apis du code](../../src/js/apis/). 
+Chaque API est définie dans un dossier distinct des autres. Cela les rend indépendantes les unes des autres. Et pour une même appellation, on a une indépendance entre deux versions différentes. On trouvera des exemples d'implémentation dans le dossier des {{ '[apis du code]({}/tree/{}/src/js/apis)'.format(repo_url, repo_branch) }}. 
 
 #### Notion de moteur 
 

documentation/developers/functionnalities.md

@@ -174,4 +174,4 @@ PGRouting gère tout les types de contraintes, des plus simples au plus complexe
 
 Le GetCapabilities est une réponse JSON qui décrit les paramètres de chaque opérations et les valeurs disponibles pour une instance de Road2. 
 
-On trouvera un exemple dans la [documentation](../apis/simple/1.0.0/). 
+On trouvera un exemple dans la {{ '[documentation]({}/tree/{}/documentation/apis/simple/1.0.0/)'.format(repo_url, repo_branch) }}. 

documentation/docker/readme.md

@@ -9,5 +9,5 @@ Il y a un sous-dossier pour les grands usages identifiés :
 
 D'autres sous-dossiers sont ordonnés ainsi pour des raisons pratiques : 
 - [web](./web/readme.md) : Ce dossier regroupe des fichiers utiles pour avoir un petit site web qui contient plusieurs documentations et des pages de tests graphiques pour Road2. 
-- [config](./config/) : Ce dossier regroupe plusieurs fichiers de configurations qui se trouvent être communs aux autres sous-dossiers. 
+- {{ '[config]({}/tree/{}/docker/config/)'.format(repo_url, repo_branch) }} : Ce dossier regroupe plusieurs fichiers de configurations qui se trouvent être communs aux autres sous-dossiers. 
 - [distributions](./distributions/readme.md) : Ce dossier peut regrouper différents `Dockerfile` qui sont des exemples d'installation sous différentes distributions. Actuellement, il ne reste plus qu'un exemple pour Debian. C'est le Dockerfile préconisé pour développer sur Road2 car il contient tous les binaires utiles aux différents moteurs. 

documentation/docker/test/readme.md

@@ -19,7 +19,7 @@ Il suffit de lancer la commande `docker-compose build`.
 
 ### Tests de charge avec gatling
 
-Après avoir rempli le `.env` en pointant, par exemple, sur le `user-files` de ce [dépôt](../../test/load/gatling/user-files) et en ayant pris soin de choisir un scénario, il suffit d'exécuter la commande :
+Après avoir rempli le `.env` en pointant, par exemple, sur le `user-files` de ce {{ '[dépôt]({}/tree/{}/test/load/gatling/user-files/)'.format(repo_url, repo_branch) }} et en ayant pris soin de choisir un scénario, il suffit d'exécuter la commande :
 ```
 # Une fois le .env modifié pour choisir le scénario notamment
 # Choisir le scénario (attention road2Docker ne fonctionne pas tant que docker-compose up generate-load-data n'a pas été appelé au moins une fois)

documentation/index.md

@@ -1,4 +1,10 @@
-# Road2
+# {{ title }} - Documentation
+
+> **Description:** {{ description }}  
+> **Auteur et contributeurs:** {{ author }}  
+> **Version:** {{ version }}  
+> **Code source:** {{ repo_url }}  
+> **Dernière mise à jour de la documentation:** {{ date_update }}
 
 ## Présentation générale 
 

documentation/test/load/readme.md

@@ -10,7 +10,7 @@ Si Gatling est installé sur la machine, on pourra pointer le dossier `user-file
 
 Autrement, il est possible d'utiliser l'image docker disponible sur [dockerhub](https://hub.docker.com/r/denvazh/gatling). 
 
-C'est ce qui est fait dans le [docker-compose](../../docker/test/) dédié aux tests dans ce dépôt. Voir le [readme](../../docker/test/readme.md) pour son utilisation. 
+C'est ce qui est fait dans le {{ '[docker-compose]({}/tree/{}/docker/test/)'.format(repo_url, repo_branch) }} dédié aux tests dans ce dépôt. Voir le [readme](../../docker/test/readme.md) pour son utilisation. 
 
 ## random-route-generator