Premier essai en Markdown

README.md

@@ -0,0 +1,8 @@
+Documentation du Vhéliotech
+=======================================
+
+Ce dépôt est un test de documentation collaborative pour le Vhéliotech.
+
+::::{important}
+Ceci n'est pas la documentation officielle du Vhélio, vous la trouverez à cette adresse : https://communaute.vhelio.org/d/4-documentation-du-vheliotech-indice-001-mars-2022
+::::

README.rst

@@ -1,9 +0,0 @@
-Template for the Read the Docs tutorial
-=======================================
-
-This GitHub template includes fictional Python library
-with some basic Sphinx docs.
-
-Read the tutorial here:
-
-https://docs.readthedocs.io/en/stable/tutorial/

docs/source/api.rst

@@ -1,7 +0,0 @@
-API
-===
-
-.. autosummary::
-   :toctree: generated
-
-   lumache

docs/source/conf.py

@@ -2,12 +2,12 @@
 
 # -- Project information
 
-project = 'Lumache'
+project = 'Vheliotech'
-copyright = '2021, Graziella'
+copyright = '2022, Velo solaire pour tous'
-author = 'Graziella'
+author = 'Velo solaire pour tous'
 
-release = '0.1'
+release = '1.0'
-version = '0.1.0'
+version = '1.0.0'
 
 # -- General configuration
 
@@ -17,6 +17,7 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    'myst_parser',
 ]
 
 intersphinx_mapping = {

docs/source/documentation.md

@@ -0,0 +1,19 @@
+# Documentation
+En plus du guide de montage (que vous êtes en train de lire), plusieurs documents sont disponibles autour du vhéliotech. Vous en trouverez une présentation rapide dans cette section.
+## Plans 3D
+Les plans 3D sont disponibles sous différents formats. Il s’agit du même contenu à chaque fois, mais utilisable par différents logiciels :
+    • PDF, que vous pouvez visualiser avec Adobe Acrobat Reader (logiciel gratuit installé sur la plupart des ordinateurs, les autres lecteurs PDF ne prennent généralement pas en charge l’affichage 3D). Un tutoriel sur la visualisation de ces plans sera publié prochainement sur le site internet.
+    • STEP, utilisable par la plupart des logiciels de CAO (Conception Assistée par Ordinateur). Vous pouvez les visualiser par exemple avec edrawings (logiciel gratuit)
+    • FCStd, pour utilisation avec FreeCAD (logiciel libre et gratuit)
+Ces plans sont particulièrement utiles pour observer des points de détail du vhéliotech ou si vous n’arrivez pas à vous représenter certaines parties, puisqu’il est possible de le voir sous tous les angles. Ils permettent également d’exporter des vues 2D ou 3D de l’assemblage ou de chaque pièce, par exemple avec FreeCAD, mais cela sort du périmètre du présent guide.
+
+## Nomenclature
+La nomenclature rassemble des informations sur toutes les pièces du vhéliotech : le code de la pièce, son nom, des liens vers des fournisseurs, etc. Les codes indiqués dans le présent guide de montage font référence à la nomenclature.
+
+```{image} img/codification_nomenclature.png
+:alt: Codification nomenclature
+:align: center
+```
+
+## Schéma électrique
+Le schéma électrique donne une vue d’ensemble de l’installation électrique, et sert de référence pour tous les branchements. Une procédure d’installation est également proposée dans le présent guide.

docs/source/index.md

@@ -0,0 +1,38 @@
+Bienvenue dans la documentation Vhéliotech
+===================================
+
+Guide de montage – Indice 0.01 - Mars 2022
+
+::::{important}
+Ceci n'est pas la documentation officielle du Vhélio, vous la trouverez à cette adresse : https://communaute.vhelio.org/d/4-documentation-du-vheliotech-indice-001-mars-2022
+::::
+
+```{image} img/vhelio.png
+:alt: Vue vhélio perspective
+:align: center
+```
+
+```{image} img/vhelio_logo.png
+:alt: Logo vhélio
+:align: center
+```
+::::{note}
+Le projet vhélio est collaboratif (amélioration continue grâce aux contributions de tous). L’objet vhéliotech et le présent document sont en version bêta (1re version). Vous êtes invités à faire part de vos retours/expériences/propositions d’améliorations sur le forum https://communaute.vhelio.org.
+
+Cette version bêta du guide n’intègre que la configuration « Intégrale » du vhéliotech. Certaines adaptations sont à prévoir pour les autres versions (certaines pièces sont à ignorer, certains tubes à raccourcir…).
+::::
+
+::::{important}
+IMPORTANT : Ce document est indicatif et non contractuel. L’association décline toute responsabilité quant à l’usage de ces documents et/ou du vhéliotech par son ou ses utilisateur(s). L’usage de ces documents ne dispense pas de la connaissance et du respect de la réglementation en vigueur. L’usage du vhéliotech reste sous la responsabilité de son utilisateur. Le vhéliotech est un produit non homologué. Il est interdit que celui-ci soit vendu, loué, prêté à entreprises/associations/collectivités. Son usage à titre professionnel ou commercial n’est pas autorisé.
+
+Le nom de marque vhélio ne peut être utilisé sans autorisation de l’association vélo solaire pour tous. Déposé à l’INPI (21 4 733 066 le 15 février 2021).
+::::
+
+Copyright Vélo Solaire Pour Tous, Mars 2022, sous licence CERN-OHL-S version 2
+
+## Contents
+
+
+```{toctree}
+   documentation
+```

docs/source/index.rst

@@ -1,22 +0,0 @@
-Welcome to Lumache's documentation!
-===================================
-
-**Lumache** (/lu'make/) is a Python library for cooks and food lovers
-that creates recipes mixing random ingredients.
-It pulls data from the `Open Food Facts database <https://world.openfoodfacts.org/>`_
-and offers a *simple* and *intuitive* API.
-
-Check out the :doc:`usage` section for further information, including
-how to :ref:`installation` the project.
-
-.. note::
-
-   This project is under active development.
-
-Contents
---------
-
-.. toctree::
-
-   usage
-   api

docs/source/usage.rst

@@ -1,34 +0,0 @@
-Usage
-=====
-
-.. _installation:
-
-Installation
-------------
-
-To use Lumache, first install it using pip:
-
-.. code-block:: console
-
-   (.venv) $ pip install lumache
-
-Creating recipes
-----------------
-
-To retrieve a list of random ingredients,
-you can use the ``lumache.get_random_ingredients()`` function:
-
-.. autofunction:: lumache.get_random_ingredients
-
-The ``kind`` parameter should be either ``"meat"``, ``"fish"``,
-or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
-will raise an exception.
-
-.. autoexception:: lumache.InvalidKindError
-
-For example:
-
->>> import lumache
->>> lumache.get_random_ingredients()
-['shells', 'gorgonzola', 'parsley']
-

lumache.py

@@ -1,23 +0,0 @@
-"""
-Lumache - Python library for cooks and food lovers.
-"""
-
-__version__ = "0.1.0"
-
-
-class InvalidKindError(Exception):
-    """Raised if the kind is invalid."""
-    pass
-
-
-def get_random_ingredients(kind=None):
-    """
-    Return a list of random ingredients as strings.
-
-    :param kind: Optional "kind" of ingredients.
-    :type kind: list[str] or None
-    :raise lumache.InvalidKindError: If the kind is invalid.
-    :return: The ingredients list.
-    :rtype: list[str]
-    """
-    return ["shells", "gorgonzola", "parsley"]

pyproject.toml

@@ -3,6 +3,6 @@ requires = ["flit_core >=3.2,<4"]
 build-backend = "flit_core.buildapi"
 
 [project]
-name = "lumache"
+name = "vheliotech"
-authors = [{name = "Graziella", email = "graziella@lumache"}]
+authors = [{name = "Velo solaire pour tous", email = "contact@vhelio.org"}]
 dynamic = ["version", "description"]