test 20230209

This commit is contained in:
Guillaume RYCKELYNCK 2023-02-09 10:59:15 +01:00
parent 5a40eac0a2
commit 0bc01b3963
39 changed files with 554 additions and 0 deletions

26
.readthedocs.yaml Normal file
View File

@ -0,0 +1,26 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# seul le HTML en ligne est supporté par MKDocs
# formats:
# - pdf
# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.9"
mkdocs:
configuration: mkdocs.yml
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements.txt

22
docs/css/extra.css Normal file
View File

@ -0,0 +1,22 @@
:root {
--md-primary-fg-color:#85127e;
--md-primary-fg-color--light:#85127e;
--md-primary-fg-color--dark:#85127e;
--md-primary-bg-color:#fff;
--md-primary-bg-color--light:#ffffffb3;
--md-accent-fg-color:#526cfe;
--md-accent-fg-color--transparent:#526cfe1a;
--md-accent-bg-color:#fff;
--md-accent-bg-color--light:#ffffffb3
}
h1, h2, h3 {
color:rgb(133, 18, 126)!important;
font-weight:600!important;
}
footer {
background-color: #500b4c!important;
}

View File

@ -0,0 +1,5 @@
# Prendre en main rapidement
Documentation assez courte sur la manière de s'y retrouver très rapidement dans le produit (en quelques clics), en focalisant sur les fonctionnalités essentielles, pour ne pas perdre des utilisateurs débutants ou peu à l'aise avec ce type d'outil.
Si possible mettre des images et/ou schémas pour alléger visuellement, voire mettre une vidéo tutoriel.

View File

@ -0,0 +1,8 @@
# Vue globale
Vue globale de la page qui apparaît lorsque l'on ouvre le composant.
Exemple pour Mapstore :
![](/docs/guide_utilisateur/images/vue_globale.PNG)

View File

@ -0,0 +1,8 @@
# Vue globale
Vue globale de la page qui apparaît lorsque l'on ouvre le produit, avec encards ou numéros localisant et nommant les différents outils décrits dans les différentes parties.
Exemple de vue globale Mapstore2 :
![](/images/00_vue_globale.PNG)

View File

@ -0,0 +1,4 @@
# Barre ou menu d'outils 1
Présentation d'un premier ensemble d'outils, avec captures d'écran à l'appui le plus souvent possible pour ne pas perdre l'utilisateur.
Les images sont stockées dans le répertoire `images`.

View File

@ -0,0 +1,4 @@
# Barre ou menu d'outils 2
Présentation d'un second ensemble d'outils, avec captures d'écran à l'appui le plus souvent possible pour ne pas perdre l'utilisateur.
Les images sont stockées dans le répertoire `images`.

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 MiB

View File

@ -0,0 +1 @@
dossier image

View File

@ -0,0 +1,23 @@
# Sommaire du guide utilisateur
Cette page est dédiée au sommaire du guide utilisateur du composant, c'est-à-dire à la documentation de référence qui décrit toutes les fonctionnalités et outils du composant à destination des **utilisateurs**.
La table des matières pour le guide est intégrée ici.
**Recommandations**:
- Après cette page, commencer par une partie "Vue globale" de l'outil qui présente la fenêtre principale du composant.
- Ajouter un maximum de captures d'écran pour illustrer. Les images sont stockées dans le répertoire `images`.
Exemple d'arborescence du guide pour Mapstore2 :
- Vue globale du composant
- Gérer les paramètres des couches
- La table attributaire
- La barre de menus
- Imprimer une carte
...

View File

@ -0,0 +1,5 @@
# Prendre en main rapidement
Documentation assez courte sur la manière de s'y retrouver très rapidement dans le composant (en quelques clics), en focalisant sur les fonctionnalités essentielles, pour ne pas perdre des utilisateurs débutants ou peu à l'aise avec ce type d'outil.
Si possible mettre des images et/ou schémas pour alléger visuellement, voire mettre une vidéo tutoriel.

View File

@ -0,0 +1 @@
dossier image

Binary file not shown.

After

Width:  |  Height:  |  Size: 141 KiB

View File

@ -0,0 +1,24 @@
# Sommaire
Sommaire de la partie Administrer
Cette partie de la documentation est dédiée à l'administration du contenu:
- gestion des données,
- mise à jour des données
- gestion des utilisateurs
- ...
Mettre les images dans le répertoire imgages
![](./images/gesiton_donnees.jpg)

View File

@ -0,0 +1,7 @@
# Une page
Une page de la partie "Administrer"

View File

@ -0,0 +1,9 @@
# Documentation de l'API
- donner les URL vers les API
- décrire les méthodes des API (sauf si swagger intégré -> url vers le swagger)

View File

@ -0,0 +1 @@
dossier image

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

View File

@ -0,0 +1,17 @@
# Sommaire
Sommaire de la partie "Développer"
![](images/developper.jpg)
Voici ce qui est attendu comme documentation pour cette partie :
- décrire la séparation entre la partie client et la partie serveur
- donner les URL vers les API
- décrire les méthodes des API (sauf si swagger intégré)
- matrice des fonctionnalités
Si cela est possible et pertinent : documenter la création ou l'utilisation d'un modèle (template) de développement utilisant le composant.
Les images sont stokées dans le répertoire `images`.

View File

@ -0,0 +1,8 @@
# Matrice des fonctionnalités
Décrire ici la liste des fonctionnalités, sous la forme de tableau si possible ?

View File

@ -0,0 +1 @@
dossier image

View File

@ -0,0 +1,7 @@
# Index des guides techniques
## Sommaire
sommaire

View File

@ -0,0 +1,12 @@
# Présentation
## Architecture composant
Présentation de la hiérarchie du composant
## Recommandation
Recommandation sur l'architecture de l'installation

View File

@ -0,0 +1,10 @@
# Prérequis
## Matériel
5 Go de ram, 2 cpu, 10Go disques, etc.
## Logiciel
Indiquer les dépendances à des librairies ou logiciels.

View File

@ -0,0 +1,3 @@
# Préparation
Comment préparer les prérequis

View File

@ -0,0 +1,7 @@
# Installation
Comment installer le composant:
- git clonne / télécharge les binaires
- installer les dependances/librairie requise
- démarrer une démo avec configuration par défaut

View File

@ -0,0 +1,7 @@
# Configuration
Comment configurer le composant:
- explication des différentes brique de configuration (ou et quoi)
- liste des configurations possible
- exemple avec des cas concret, je veux faire ça avec la réponse

View File

@ -0,0 +1,13 @@
# Debug
## Debug
Comment obtenir du debug (+plus d'information dans la console ?)
## Log
Comment son construit les logs
Ou sont il stocker par default (ou envoyé à distance)
Comment modifier la localisation/cible distante

View File

@ -0,0 +1,5 @@
# Tests
Vérification que tout est fonctionnel
Indication de la page de status ?

View File

@ -0,0 +1 @@
dossier image

View File

@ -0,0 +1,21 @@
# Sommaire
Sommaire de la partie Installer
## [Présentation](guides_techniques/installer/00_presentation.md#presentation)
### [Architecture composant](guides_techniques/installer/00_presentation.md#architecture-composant)
### [Recommandation](guides_techniques/installer/00_presentation.md#recommandation)
## [Prérequis](guides_techniques/installer/01_prerequis.md#prerequis)
### [Matériel](guides_techniques/installer/01_prerequis.md#materiel)
### [Logiciel](guides_techniques/installer/01_prerequis.md#logiciel)
## [Préparation](guides_techniques/installer/02_preparation.md#preparation)
## [Installation](guides_techniques/installer/03_installation.md#installation)
## [Configuration](guides_techniques/installer/04_configuration.md#configuration)
## [Debug](guides_techniques/installer/05_debug.md#debug)
### [Debug](guides_techniques/installer/05_debug.md#debug_1)
### [Log](guides_techniques/installer/05_debug.md#log)
## [Tests](guides_techniques/installer/06_tests.md#tests)

View File

@ -0,0 +1,7 @@
# Une page
Une page de la partie "Administrer"

BIN
docs/images/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

View File

@ -0,0 +1,104 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
width="72.919884mm"
height="22.149282mm"
viewBox="0 0 72.919884 22.149282"
version="1.1"
id="svg855"
inkscape:version="1.1 (c68e22c387, 2021-05-23)"
sodipodi:docname="georchestra-logo-white.svg"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<sodipodi:namedview
id="namedview857"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageshadow="2"
inkscape:pageopacity="0.0"
inkscape:pagecheckerboard="0"
inkscape:document-units="mm"
showgrid="false"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0"
inkscape:zoom="0.72337262"
inkscape:cx="200.44994"
inkscape:cy="-43.546022"
inkscape:window-width="2400"
inkscape:window-height="1271"
inkscape:window-x="2391"
inkscape:window-y="-9"
inkscape:window-maximized="1"
inkscape:current-layer="layer1" />
<defs
id="defs852" />
<g
inkscape:label="Calque 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(-52.054836,-159.73694)">
<path
id="path164290-3-6"
style="fill:#ffffff;fill-opacity:0.284345;stroke-width:0.669754;stroke-linecap:round;stroke-linejoin:round;paint-order:markers stroke fill"
d="m 63.129334,159.73694 a 11.074759,11.074759 0 0 0 -11.074498,11.07479 11.074759,11.074759 0 0 0 11.074498,11.07449 11.074759,11.074759 0 0 0 10.631194,-7.99156 3.3498344,3.9081402 0 0 1 -2.226031,-3.67996 3.3498344,3.9081402 0 0 1 1.879629,-3.50893 11.074759,11.074759 0 0 0 -10.284792,-6.96883 z"
inkscape:export-filename="C:\Users\Agathe\Desktop\georchestra_univers.png"
inkscape:export-xdpi="200"
inkscape:export-ydpi="200" />
<path
id="path20251-5-9-8"
style="fill:#ffffff;fill-opacity:1;stroke-width:0.37285;stroke-linecap:round;stroke-linejoin:round;paint-order:markers stroke fill"
d="m 75.888488,164.67988 a 5.5118612,5.5118612 0 0 0 -5.512009,5.51202 5.5118612,5.5118612 0 0 0 5.512009,5.51172 5.5118612,5.5118612 0 0 0 5.511721,-5.51172 5.5118612,5.5118612 0 0 0 -5.511721,-5.51202 z m 0,2.96527 a 2.5466196,2.5466196 0 0 1 2.546477,2.54675 2.5466196,2.5466196 0 0 1 -2.546477,2.54647 2.5466196,2.5466196 0 0 1 -2.546752,-2.54647 2.5466196,2.5466196 0 0 1 2.546752,-2.54675 z"
inkscape:export-filename="C:\Users\Agathe\Desktop\georchestra_univers.png"
inkscape:export-xdpi="200"
inkscape:export-ydpi="200" />
<g
aria-label="ge rchestra"
id="text10089-26-6"
style="font-size:10.6397px;line-height:1.25;font-family:Roboto;-inkscape-font-specification:'Roboto, Normal';letter-spacing:0px;fill:#ffffff;stroke-width:0.664982">
<path
d="m 59.655488,175.5645 q -0.736769,0 -1.265731,-0.19647 -0.528963,-0.19647 -0.850118,-0.52518 -0.321156,-0.32872 -0.44584,-0.72166 l 1.231727,-0.29849 q 0.08312,0.15491 0.241811,0.31738 0.158689,0.16625 0.426948,0.27582 0.272038,0.11335 0.683873,0.11335 0.581859,0 0.963467,-0.2796 0.381609,-0.27959 0.381609,-0.90301 v -1.09949 h -0.06801 q -0.105792,0.21159 -0.309821,0.43451 -0.20025,0.22292 -0.53274,0.37405 -0.328713,0.15113 -0.827449,0.15113 -0.668759,0 -1.212835,-0.3136 -0.540297,-0.31738 -0.861453,-0.94457 -0.317377,-0.63098 -0.317377,-1.57934 0,-0.95591 0.317377,-1.61333 0.321156,-0.6612 0.865232,-1.00125 0.544075,-0.34383 1.212835,-0.34383 0.510071,0 0.838783,0.17381 0.332491,0.17002 0.528962,0.41183 0.196472,0.23803 0.298486,0.44962 h 0.07557 v -0.95969 h 1.348854 v 5.89793 q 0,0.72921 -0.35516,1.21284 -0.355161,0.4874 -0.971024,0.72543 -0.615863,0.24181 -1.397972,0.24181 z m 0.01134,-3.4307 q 0.434505,0 0.740547,-0.21158 0.306043,-0.21159 0.464732,-0.60831 0.158688,-0.39672 0.158688,-0.95213 0,-0.54786 -0.158688,-0.95969 -0.154911,-0.41184 -0.460953,-0.63853 -0.302265,-0.23048 -0.744326,-0.23048 -0.457175,0 -0.763217,0.23803 -0.306043,0.23804 -0.460953,0.65365 -0.15491,0.41183 -0.15491,0.93702 0,0.53274 0.15491,0.93324 0.158689,0.39672 0.464731,0.61964 0.309821,0.21914 0.759439,0.21914 z"
id="path2468" />
<path
d="m 66.354415,173.40331 q -0.872788,0 -1.507543,-0.36272 -0.630977,-0.36649 -0.971024,-1.03525 -0.340047,-0.67254 -0.340047,-1.58311 0,-0.89546 0.340047,-1.57177 0.343826,-0.6801 0.959689,-1.05793 0.615863,-0.38161 1.44709,-0.38161 0.536519,0 1.012585,0.17381 0.479844,0.17002 0.84634,0.52896 0.370273,0.35894 0.581858,0.91435 0.211585,0.55163 0.211585,1.31485 v 0.41939 h -4.756883 v -0.92191 h 3.445812 q -0.0038,-0.39294 -0.170023,-0.69898 -0.166246,-0.30982 -0.464732,-0.4874 -0.294707,-0.17758 -0.687651,-0.17758 -0.419391,0 -0.736769,0.20402 -0.317377,0.20025 -0.494957,0.52897 -0.173802,0.32493 -0.17758,0.7141 v 0.80477 q 0,0.5063 0.185136,0.86901 0.185137,0.35894 0.517628,0.55164 0.33249,0.18891 0.77833,0.18891 0.298486,0 0.540297,-0.0831 0.241812,-0.0869 0.419392,-0.25315 0.17758,-0.16624 0.268259,-0.41183 l 1.277067,0.14357 q -0.120906,0.50629 -0.460953,0.88412 -0.336269,0.37406 -0.861453,0.58186 -0.525184,0.20403 -1.2015,0.20403 z"
id="path2470" />
<path
d="m 83.296304,173.28996 v -5.80347 h 1.326185 v 0.96725 h 0.06045 q 0.158689,-0.50252 0.544076,-0.77456 0.389165,-0.27581 0.887901,-0.27581 0.113349,0 0.253146,0.0113 0.143576,0.008 0.238033,0.0264 v 1.25818 q -0.0869,-0.0302 -0.275816,-0.0529 -0.185136,-0.0265 -0.358938,-0.0265 -0.374052,0 -0.672538,0.16247 -0.294708,0.15869 -0.464731,0.44206 -0.170024,0.28337 -0.170024,0.65365 v 3.4118 z"
style="font-weight:600;font-family:inter;-inkscape-font-specification:'inter Semi-Bold'"
id="path2472" />
<path
d="m 89.806311,173.40331 q -0.869009,0 -1.492429,-0.38161 -0.619642,-0.38161 -0.955911,-1.05414 -0.33249,-0.67632 -0.33249,-1.55666 0,-0.88413 0.340047,-1.56044 0.340047,-0.6801 0.959689,-1.05793 0.62342,-0.38161 1.473538,-0.38161 0.706542,0 1.250618,0.26071 0.547854,0.25692 0.872788,0.72921 0.324934,0.46851 0.370273,1.09571 h -1.307292 q -0.07934,-0.41939 -0.37783,-0.69899 -0.294708,-0.28337 -0.789666,-0.28337 -0.419391,0 -0.736769,0.2267 -0.317377,0.22292 -0.494957,0.64231 -0.173802,0.41939 -0.173802,1.00503 0,0.59319 0.173802,1.02014 0.173802,0.42317 0.487401,0.65364 0.317377,0.2267 0.744325,0.2267 0.302265,0 0.540298,-0.11335 0.241811,-0.11712 0.404278,-0.33627 0.162467,-0.21914 0.22292,-0.53274 h 1.307292 q -0.04912,0.61587 -0.362717,1.09193 -0.313599,0.47229 -0.853896,0.74055 -0.540297,0.26448 -1.26951,0.26448 z"
style="font-weight:600;font-family:inter;-inkscape-font-specification:'inter Semi-Bold'"
id="path2474" />
<path
d="m 94.786101,169.88949 v 3.40047 H 93.418356 V 165.552 h 1.337519 v 2.92063 h 0.06801 q 0.204029,-0.49118 0.630977,-0.77455 0.430726,-0.28716 1.095708,-0.28716 0.604528,0 1.054146,0.25315 0.449618,0.25315 0.695208,0.74055 0.249368,0.4874 0.249368,1.19016 v 3.69518 h -1.367746 v -3.48359 q 0,-0.58564 -0.302264,-0.91057 -0.298486,-0.32872 -0.838783,-0.32872 -0.362717,0 -0.649868,0.15869 -0.283373,0.15491 -0.44584,0.44962 -0.158689,0.29471 -0.158689,0.7141 z"
style="font-weight:600;font-family:inter;-inkscape-font-specification:'inter Semi-Bold'"
id="path2476" />
<path
d="m 102.50893,173.40331 q -0.87278,0 -1.50754,-0.36272 -0.63098,-0.36649 -0.97102,-1.03525 -0.34005,-0.67254 -0.34005,-1.58311 0,-0.89546 0.34005,-1.57177 0.34382,-0.6801 0.95969,-1.05793 0.61586,-0.38161 1.44709,-0.38161 0.53651,0 1.01258,0.17381 0.47984,0.17002 0.84634,0.52896 0.37027,0.35894 0.58186,0.91435 0.21158,0.55163 0.21158,1.31485 v 0.41939 h -4.75688 v -0.92191 h 3.44581 q -0.004,-0.39294 -0.17002,-0.69898 -0.16625,-0.30982 -0.46473,-0.4874 -0.29471,-0.17758 -0.68765,-0.17758 -0.41939,0 -0.73677,0.20402 -0.31738,0.20025 -0.49496,0.52897 -0.1738,0.32493 -0.17758,0.7141 v 0.80477 q 0,0.5063 0.18514,0.86901 0.18513,0.35894 0.51762,0.55164 0.3325,0.18891 0.77833,0.18891 0.29849,0 0.5403,-0.0831 0.24181,-0.0869 0.41939,-0.25315 0.17758,-0.16624 0.26826,-0.41183 l 1.27707,0.14357 q -0.12091,0.50629 -0.46095,0.88412 -0.33627,0.37406 -0.86146,0.58186 -0.52518,0.20403 -1.2015,0.20403 z"
style="font-weight:600;font-family:inter;-inkscape-font-specification:'inter Semi-Bold'"
id="path2478" />
<path
d="m 110.83253,169.02048 -1.24684,0.13602 q -0.0529,-0.18892 -0.18514,-0.35516 -0.12846,-0.16625 -0.3476,-0.26826 -0.21914,-0.10201 -0.53652,-0.10201 -0.42695,0 -0.71788,0.18513 -0.28715,0.18514 -0.28337,0.47985 -0.004,0.25314 0.18513,0.41183 0.1927,0.15869 0.63476,0.2607 l 0.98991,0.21159 q 0.82367,0.17758 1.22417,0.56297 0.40428,0.38538 0.40806,1.0088 -0.004,0.54786 -0.32115,0.96725 -0.3136,0.41561 -0.87279,0.64987 -0.55919,0.23425 -1.28463,0.23425 -1.06548,0 -1.71534,-0.44584 -0.64987,-0.44962 -0.77456,-1.25062 l 1.33374,-0.12846 q 0.0907,0.39295 0.38539,0.5932 0.29471,0.20025 0.767,0.20025 0.4874,0 0.78211,-0.20025 0.29848,-0.20025 0.29848,-0.49496 0,-0.24937 -0.19269,-0.41184 -0.18892,-0.16246 -0.58942,-0.24937 l -0.98991,-0.2078 q -0.83501,-0.1738 -1.23551,-0.58564 -0.4005,-0.41561 -0.39672,-1.05037 -0.004,-0.53652 0.29093,-0.92946 0.29849,-0.39672 0.82745,-0.61208 0.53274,-0.21915 1.22795,-0.21915 1.02014,0 1.60578,0.43451 0.58941,0.4345 0.72921,1.17505 z"
style="font-weight:600;font-family:inter;-inkscape-font-specification:'inter Semi-Bold'"
id="path2480" />
<path
d="m 114.98488,167.48649 v 1.05792 h -3.33624 v -1.05792 z m -2.51257,-1.39042 h 1.36774 v 5.44832 q 0,0.27581 0.0831,0.42317 0.0869,0.14357 0.2267,0.19647 0.1398,0.0529 0.30982,0.0529 0.12847,0 0.23426,-0.0189 0.10957,-0.0189 0.16624,-0.034 l 0.23048,1.06926 q -0.10957,0.0378 -0.3136,0.0831 -0.20025,0.0453 -0.49118,0.0529 -0.51385,0.0151 -0.92568,-0.15491 -0.41184,-0.17381 -0.65365,-0.53652 -0.23803,-0.36272 -0.23425,-0.90679 z"
style="font-weight:600;font-family:inter;-inkscape-font-specification:'inter Semi-Bold'"
id="path2482" />
<path
d="m 116.12969,173.28996 v -5.80347 h 1.32619 v 0.96725 h 0.0605 q 0.15869,-0.50252 0.54408,-0.77456 0.38916,-0.27581 0.8879,-0.27581 0.11335,0 0.25314,0.0113 0.14358,0.008 0.23804,0.0264 v 1.25818 q -0.0869,-0.0302 -0.27582,-0.0529 -0.18514,-0.0265 -0.35894,-0.0265 -0.37405,0 -0.67254,0.16247 -0.2947,0.15869 -0.46473,0.44206 -0.17002,0.28337 -0.17002,0.65365 v 3.4118 z"
style="font-weight:600;font-family:inter;-inkscape-font-specification:'inter Semi-Bold'"
id="path2484" />
<path
d="m 121.91048,173.40709 q -0.55163,0 -0.9937,-0.19647 -0.43828,-0.20025 -0.6952,-0.58942 -0.25315,-0.38916 -0.25315,-0.95969 0,-0.49117 0.18136,-0.81233 0.18136,-0.32116 0.49496,-0.51385 0.3136,-0.19269 0.70654,-0.29093 0.39672,-0.10201 0.81989,-0.14735 0.51007,-0.0529 0.82745,-0.0945 0.31738,-0.0453 0.46095,-0.13602 0.14736,-0.0945 0.14736,-0.29093 v -0.0227 q 0,-0.42695 -0.25315,-0.6612 -0.25315,-0.23426 -0.72921,-0.23426 -0.50252,0 -0.79722,0.21915 -0.29093,0.21914 -0.39295,0.51762 l -1.27706,-0.18136 q 0.15113,-0.52896 0.49873,-0.88412 0.34761,-0.35894 0.85012,-0.53652 0.50251,-0.18136 1.11082,-0.18136 0.41939,0 0.83501,0.0982 0.41561,0.0982 0.75943,0.32493 0.34383,0.22292 0.55164,0.60831 0.21158,0.38539 0.21158,0.96347 v 3.88409 h -1.31485 v -0.79722 h -0.0453 q -0.12468,0.24181 -0.35138,0.4534 -0.22292,0.2078 -0.56297,0.33627 -0.33627,0.12468 -0.78966,0.12468 z m 0.35516,-1.00503 q 0.41183,0 0.7141,-0.16247 0.30226,-0.16624 0.46473,-0.43828 0.16624,-0.27204 0.16624,-0.59319 v -0.68387 q -0.0642,0.0529 -0.21914,0.0982 -0.15113,0.0453 -0.34004,0.0794 -0.18892,0.034 -0.37406,0.0605 -0.18513,0.0264 -0.32115,0.0453 -0.30604,0.0416 -0.54786,0.13602 -0.24181,0.0945 -0.3816,0.26448 -0.1398,0.16624 -0.1398,0.43072 0,0.37783 0.27581,0.57053 0.27582,0.19269 0.70277,0.19269 z"
style="font-weight:600;font-family:inter;-inkscape-font-specification:'inter Semi-Bold'"
id="path2486" />
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 488 KiB

17
docs/index.md Normal file
View File

@ -0,0 +1,17 @@
# Accueil
## C'est quoi ?
Cette page sert simplement de test de la documentation geOrchestra.
</br>
![image info](./images/joyeux-collegues-utilisant-ordinateurs-portables.jpg)
[Freepik](https://fr.freepik.com/photos-gratuite/joyeux-collegues-utilisant-ordinateurs-portables_2317379.htm#query=people%20working%20office)
Je sais faire / Je sais PAS faire (périmètre fonctionnel)
le pitch
exemples + liens

47
docs/tableofcontent.md Normal file
View File

@ -0,0 +1,47 @@
<!-- ====================== TOC ====================== -->
<!-- Generated by mkdocs-toc-md plugin -->
<!-- ================================================= -->
# Contents
Summary of the section
## [Sommaire du guide utilisateur](guide_utilisateur\index.md#sommaire-du-guide-utilisateur)
## [Prendre en main rapidement](guide_utilisateur\00_prise_en_main.md#prendre-en-main-rapidement)
## [Vue globale](guide_utilisateur\01_vue_globale.md#vue-globale)
## [Barre ou menu d'outils 1](guide_utilisateur\02_outils_1.md#barre-ou-menu-doutils-1)
## [Barre ou menu d'outils 2](guide_utilisateur\03_outils_2.md#barre-ou-menu-doutils-2)
## [Index des guides techniques](guides_techniques\index.md#index-des-guides-techniques)
### [Sommaire](guides_techniques\index.md#sommaire)
## [Sommaire](guides_techniques\administrer\index.md#sommaire)
## [Une page](guides_techniques\administrer\une_page.md#une-page)
## [Sommaire](guides_techniques\installer\index.md#sommaire)
### [Présentation](guides_techniques\installer\index.md#presentation)
* [Architecture composant](guides_techniques\installer\index.md#architecture-composant)
* [Recommandation](guides_techniques\installer\index.md#recommandation)
### [Prérequis](guides_techniques\installer\index.md#prerequis)
* [Matériel](guides_techniques\installer\index.md#materiel)
* [Logiciel](guides_techniques\installer\index.md#logiciel)
### [Préparation](guides_techniques\installer\index.md#preparation)
### [Installation](guides_techniques\installer\index.md#installation)
### [Configuration](guides_techniques\installer\index.md#configuration)
### [Debug](guides_techniques\installer\index.md#debug)
* [Debug](guides_techniques\installer\index.md#debug_1)
* [Log](guides_techniques\installer\index.md#log)
### [Tests](guides_techniques\installer\index.md#tests)
## [Présentation](guides_techniques\installer\00_presentation.md#presentation)
### [Architecture composant](guides_techniques\installer\00_presentation.md#architecture-composant)
### [Recommandation](guides_techniques\installer\00_presentation.md#recommandation)
## [Prérequis](guides_techniques\installer\01_prerequis.md#prerequis)
### [Matériel](guides_techniques\installer\01_prerequis.md#materiel)
### [Logiciel](guides_techniques\installer\01_prerequis.md#logiciel)
## [Préparation](guides_techniques\installer\02_preparation.md#preparation)
## [Installation](guides_techniques\installer\03_installation.md#installation)
## [Configuration](guides_techniques\installer\04_configuration.md#configuration)
## [Debug](guides_techniques\installer\05_debug.md#debug)
### [Debug](guides_techniques\installer\05_debug.md#debug_1)
### [Log](guides_techniques\installer\05_debug.md#log)
## [Tests](guides_techniques\installer\06_tests.md#tests)
## [Sommaire](guides_techniques\developper\index.md#sommaire)
## [Matrice des fonctionnalités](guides_techniques\developper\matrice_fonctionnalites.md#matrice-des-fonctionnalites)
## [Documentation de l'API](guides_techniques\developper\api.md#documentation-de-lapi)

82
mkdocs.yml Normal file
View File

@ -0,0 +1,82 @@
site_name: Test de documentation d'un composant geOrchestra - 20230209
repo_url: https://gitea.datagrandest.net/guillaume_ryckelynck/georchestra_documentation_module_test
repo_name: georchestra_documentation_module_test
docs_dir: docs
edit_uri: edit/main/docs/
theme:
language: fr
features:
- toc.integrate
- navigation.indexes
- navigation.tabs
- navigation.tabs.sticky
- navigation.footer
logo: images/georchestra-logo-white.svg
favicon: images/favicon.ico
name: material
extra:
generator: false
social:
- icon: fontawesome/solid/paper-plane
link: mailto:psc@georchestra.org
- icon: fontawesome/brands/twitter
link: https://twitter.com/georchestra
- icon: fontawesome/brands/github
link: https://github.com/georchestra
copyright: '© 2023 - georchestra'
extra_css:
- css/extra.css
# arborescence de 1er et 2e niveau à gérer ici
# Ces entrées correspondent au modèle de documentation
nav:
- Accueil: index.md
- Guide utilisateur:
- Sommaire: guide_utilisateur/index.md
- Prendre en main: guide_utilisateur/00_prise_en_main.md
- Utiliser:
- guide_utilisateur/01_vue_globale.md
- guide_utilisateur/02_outils_1.md
- guide_utilisateur/03_outils_2.md
- Guides techniques:
- Sommaire: guides_techniques/index.md
- Administrer:
- guides_techniques/administrer/index.md
- guides_techniques/administrer/une_page.md
- Installer:
- guides_techniques/installer/index.md
- guides_techniques/installer/00_presentation.md
- guides_techniques/installer/01_prerequis.md
- guides_techniques/installer/02_preparation.md
- guides_techniques/installer/03_installation.md
- guides_techniques/installer/04_configuration.md
- guides_techniques/installer/05_debug.md
- guides_techniques/installer/06_tests.md
- Développer:
- guides_techniques/developper/index.md
- guides_techniques/developper/matrice_fonctionnalites.md
- guides_techniques/developper/api.md
plugins:
- search
- toc-md:
toc_page_title: Contents
toc_page_description: Summary of the section
header_level: 3
pickup_description_meta: false
pickup_description_class: false
output_path: tableofcontent.md
output_log: true
ignore_page_pattern: index.md
remove_navigation_page_pattern: index.md
template_dir_path: custom_template
- git-revision-date-localized:
enable_creation_date: true
# TODO Documenter comment simplifier l'arborescence pour un petit projet

37
requirements.txt Normal file
View File

@ -0,0 +1,37 @@
Babel==2.11.0
beautifulsoup4==4.11.2
certifi==2022.12.7
charset-normalizer==3.0.1
click==8.1.3
colorama==0.4.6
ghp-import==2.1.0
gitdb==4.0.10
GitPython==3.1.30
html5lib==1.1
idna==3.4
importlib-metadata==6.0.0
Jinja2==3.1.2
Markdown==3.3.7
MarkupSafe==2.1.2
mergedeep==1.3.4
mkdocs==1.4.2
mkdocs-git-revision-date-localized-plugin==1.1.0
mkdocs-material==9.0.11
mkdocs-material-extensions==1.1.1
mkdocs-toc-md==0.0.4
packaging==23.0
Pygments==2.14.0
pymdown-extensions==9.9.2
python-dateutil==2.8.2
pytz==2022.7.1
PyYAML==6.0
pyyaml_env_tag==0.1
regex==2022.10.31
requests==2.28.2
six==1.16.0
smmap==5.0.0
soupsieve==2.3.2.post1
urllib3==1.26.14
watchdog==2.2.1
webencodings==0.5.1
zipp==3.12.1