Refs #91. Added docs structure based on Sphinx.

.gitignore

@@ -3,3 +3,6 @@ deploy
 /build-*
 *.user
 
+html
+venv
+doctrees

README_fr.md

@@ -0,0 +1,65 @@
+<img src="docs/logo/LogoOpenTeraPlus.png" width="500">
+
+# OpenTeraPlus
+OpenTeraPlus est un client pour le [Serveur OpenTera](https://github.com/introlab/opentera). Son rôle est d'agir comme un outil général pour gérer une instance d'OpenTera et de fournir certaines fonctionnalités spécifiques à certains services, telles que la Téléréadaptation.
+
+## Auteurs
+
+* Simon Brière, ing. M.Sc.A., Centre de recherche sur le Vieillissement (CDRV), CIUSSS de l'Estrie-CHUS (@sbriere)
+* Dominic Létourneau, ing. M.Sc.A., IntRoLab, Université de Sherbrooke (@doumdi)
+* François Michaud, ing. Ph.D., IntRoLab, Université de Sherbrooke
+* Michel Tousignant, pht, Ph.D., CDRV, Université de Sherbrooke
+
+## Publication(s)
+
+* Panchea, A.M., Létourneau, D., Brière, S. et al., [OpenTera: A microservice architecture solution for rapid prototyping of robotic solutions to COVID-19 challenges in care facilities](https://rdcu.be/cHzmf),  Health Technol. 12, 583–596 (2022)
+
+## Fonctionnalités actuelles
+
+### Aperçu des fonctionnalités
+* Gestion globale du système, incluant les accès utilisateurs - rôles pour sites, projets, appareils, types de séances et services
+* Gestion des participants (patients), incluant l'activation/désactivation, regroupements et tableaux de bord des séances
+* Intégration spécifique pour les services de téléréadaptation et toutes les activités cliniques demandant une séance audio-vidéo adaptée au contexte
+* Gestion des séances, incluant fichiers / données attachées et tests / questionnaires
+
+### Fonctionnalités détaillées
+* Connexion en tant qu'utilisateur
+  * Implémentation de l'accès selon les groupes utilisateurs
+* Gestion des projets et sites
+  * Accès des groupes utilisateurs
+  * Appareils, types de séances et évaluations liées
+  * Services associés
+* Gestion des participants (patients)
+  * Regroupement des participants
+  * Activation / désactivation des participants, liens webs et connexion traditionnelle
+  * Ajout / suppression
+* Gestion des séances
+  * Création de nouvelle séance et édition de séances existantes
+  * Vue calendrier des séances réalisées et planifiées
+  * Affichage des événements de séance
+  * Téléchargement et gestion des fichiers attachés aux séances
+  * Affichage des évaluations attachées aux séances
+* Gestion des appareils
+  * Association d'appareils aux participants
+  * Activation / désactivation d'appareils
+  * Configuration des appareils
+* Gestion des services OpenTera
+  * Édition de la configuration
+* Séances de téléréadaptation
+  * Création et gestion de séances vidéos axées sur la télésanté
+* ... et plus!
+
+# Captures d'écran
+<table><tr>
+<td><img src="docs/screenshots/LoginScreen.png" width="100" alt="Login Screen" title="Login Screen"></td>
+<td><img src="docs/screenshots/ProjectNavigator.png" width="100" alt="Project Navigator" title="Project Navigator"></td>
+<td><img src="docs/screenshots/Participant.png" width="100" alt="Participant Viewer" title="Participant Viewer"></td>
+<td><img src="docs/screenshots/SessionLobby.png" width="100" alt="Session Lobby" title="Session Lobby"></td>
+<td><img src="docs/screenshots/AdminConfig.png" width="100" alt="Admin configuration" title="Admin configuration"></td>
+</tr></table>
+
+# Vidéo
+[![OpenTera+ Logiciel Clinique de Télésanté](https://img.youtube.com/vi/FathjoDGlZ0/maxresdefault.jpg)](https://youtu.be/FathjoDGlZ0)
+
+# Licence
+OpenTeraPlus est licencé sous [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html)

docs/Home.rst

@@ -0,0 +1,3 @@
+.. include:: ../README_fr.md
+   :parser: myst_parser.sphinx_
+   :start-line: 2

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,40 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'OpenTeraPlus'
+copyright = '2023, Simon Brière, Dominic Létourneau'
+author = 'Simon Brière, Dominic Létourneau'
+release = '1.1.3'
+version = release
+
+html_logo = 'logo/LogoOpenTeraPlus.png'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['myst_parser', 'sphinx_rtd_theme', 'sphinxcontrib.openapi', 'sphinx.ext.autosummary']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'venv']
+
+locale_dirs = ['locale/']
+language = 'fr'  # Default language
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+    'navigation_depth': -1,
+    'display_version': True
+}
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}

docs/index.rst

@@ -0,0 +1,18 @@
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: Introduction
+
+.. toctree::
+   :maxdepth: 5
+   :hidden:
+   :caption: Manuel d'utilisation
+
+   users/Troubleshooting
+
+.. toctree::
+   :maxdepth: 5
+   :hidden:
+   :caption: Développeurs
+
+.. include:: Home.rst

docs/locale/en/LC_MESSAGES/index.po

@@ -0,0 +1,56 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2023, Simon Brière, Dominic Létourneau
+# This file is distributed under the same license as the OpenTeraPlus
+# package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: OpenTeraPlus 1.1.3\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2023-10-30 09:14-0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: en\n"
+"Language-Team: en <[email protected]>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.13.1\n"
+
+#: ../../index.rst:1
+msgid "Introduction"
+msgstr ""
+
+#: ../../index.rst:6
+msgid "Utilisateurs"
+msgstr ""
+
+#: ../../index.rst:13
+msgid "Développeurs"
+msgstr ""
+
+#: ../../index.rst:19
+msgid "Indices and tables"
+msgstr ""
+
+#: ../../index.rst:21
+msgid ":ref:`genindex`"
+msgstr ""
+
+#: ../../index.rst:22
+msgid ":ref:`modindex`"
+msgstr ""
+
+#: ../../index.rst:23
+msgid ":ref:`search`"
+msgstr ""
+
+#~ msgid "Contents:"
+#~ msgstr ""
+
+#~ msgid "Welcome to OpenTeraPlus's documentation!"
+#~ msgstr ""
+