From a8bcd8702115ebc3f57cd77ebc0842cea95dcd19 Mon Sep 17 00:00:00 2001 From: youen Date: Sun, 7 Aug 2022 23:46:22 +0200 Subject: [PATCH] Conversion du projet pour compiler avec Sphinx (sans readthedocs) --- .gitignore | 157 +--------- .readthedocs.yaml | 11 - LICENSE | 290 ++++++++++++++++++ docs/Makefile => Makefile | 0 README.md | 9 +- docs/requirements.txt | 2 - docs/make.bat => make.bat | 0 pyproject.toml | 8 - {docs/source => source}/accessoires.md | 0 .../assemblage_chassis_toit.md | 0 {docs/source => source}/conf.py | 1 + {docs/source => source}/documentation.md | 0 {docs/source => source}/img/arriere.png | Bin .../img/assemblage_2_toles.png | Bin .../img/assemblage_2_tubes.png | Bin .../img/assemblage_3_tubes.png | Bin .../img/assemblage_etape_1.png | Bin .../img/assemblage_etape_1.svg | 0 .../img/assemblage_etape_10.svg | 0 .../img/assemblage_etape_11.svg | 0 .../img/assemblage_etape_12.svg | 0 .../img/assemblage_etape_13.svg | 0 .../img/assemblage_etape_14.svg | 0 .../img/assemblage_etape_15.svg | 0 .../img/assemblage_etape_16.svg | 0 .../img/assemblage_etape_17.svg | 0 .../img/assemblage_etape_18.svg | 0 .../img/assemblage_etape_19.svg | 0 .../img/assemblage_etape_2.svg | 0 .../img/assemblage_etape_20.svg | 0 .../img/assemblage_etape_3.svg | 0 .../img/assemblage_etape_4.svg | 0 .../img/assemblage_etape_5.svg | 0 .../img/assemblage_etape_6.svg | 0 .../img/assemblage_etape_7.svg | 0 .../img/assemblage_etape_8.svg | 0 .../img/assemblage_etape_9.svg | 0 .../img/assemblage_tube_tole.png | Bin {docs/source => source}/img/avant.png | Bin .../source => source}/img/capteur_vitesse.png | Bin .../img/codification_nomenclature.png | Bin {docs/source => source}/img/cote_droit.png | Bin {docs/source => source}/img/cote_gauche.png | Bin .../img/coupe_altimetrique.png | Bin .../img/coupe_longitudinale.png | Bin .../img/coupe_transversale_arriere.png | Bin .../img/coupe_transversale_avant.png | Bin {docs/source => source}/img/dessous.png | Bin {docs/source => source}/img/dessus.png | Bin {docs/source => source}/img/div02.png | Bin .../source => source}/img/fixer_ch045_t16.png | Bin {docs/source => source}/img/moyeu_ca380.png | Bin {docs/source => source}/img/moyeu_nexus_8.png | Bin .../source => source}/img/photo_siege_dos.png | Bin .../img/photo_tendeur_chaine.jpg | Bin {docs/source => source}/img/qin20.png | Bin {docs/source => source}/img/roue_nexus_8.png | Bin .../img/schema_connexion_boitier_commodo.svg | 0 .../schema_connexion_boitier_luminaire.svg | 0 ...nexion_boitier_moteur_batterie_solaire.svg | 0 .../img/schema_connexion_commodo.svg | 0 .../img/schema_connexion_moteur_batterie.svg | 0 ...ma_connexion_moteur_batterie_integrale.svg | 0 ...hema_connexion_moteur_batterie_panneau.svg | 0 .../schema_connexion_panneau_integrale.svg | 0 .../img/schema_connexion_platines_arriere.svg | 0 .../img/schema_connexion_platines_avant.svg | 0 {docs/source => source}/img/tube_deforme.jpg | Bin {docs/source => source}/img/vhelio.png | Bin {docs/source => source}/img/vhelio_logo.png | Bin .../img/vis_desserree_poignee.jpg | Bin .../img/vis_serree_poignee.jpg | Bin {docs/source => source}/img/vue_3d_ch004.png | Bin {docs/source => source}/img/vue_3d_ch045.png | Bin {docs/source => source}/img/vue_3d_ch047.png | Bin {docs/source => source}/img/vue_3d_siege.png | Bin .../img/vue_3d_siege_coupe.png | Bin .../img/vue_3d_tendeur_chaine.png | Bin .../source => source}/img/vue_coupe_ch045.png | Bin .../source => source}/img/vue_coupe_ch047.png | Bin {docs/source => source}/index.md | 3 - .../installation_electricite.md | 0 .../installation_textiles.md | 0 .../montage_pieces_cycles.md | 0 {docs/source => source}/moyens_necessaires.md | 0 {docs/source => source}/plan_general.md | 0 {docs/source => source}/sieges.md | 0 {docs/source => source}/stabilisateurs.md | 0 .../source => source}/tests_verifications.md | 0 89 files changed, 296 insertions(+), 185 deletions(-) delete mode 100644 .readthedocs.yaml create mode 100644 LICENSE rename docs/Makefile => Makefile (100%) delete mode 100644 docs/requirements.txt rename docs/make.bat => make.bat (100%) delete mode 100644 pyproject.toml rename {docs/source => source}/accessoires.md (100%) rename {docs/source => source}/assemblage_chassis_toit.md (100%) rename {docs/source => source}/conf.py (96%) rename {docs/source => source}/documentation.md (100%) rename {docs/source => source}/img/arriere.png (100%) rename {docs/source => source}/img/assemblage_2_toles.png (100%) rename {docs/source => source}/img/assemblage_2_tubes.png (100%) rename {docs/source => source}/img/assemblage_3_tubes.png (100%) rename {docs/source => source}/img/assemblage_etape_1.png (100%) rename {docs/source => source}/img/assemblage_etape_1.svg (100%) rename {docs/source => source}/img/assemblage_etape_10.svg (100%) rename {docs/source => source}/img/assemblage_etape_11.svg (100%) rename {docs/source => source}/img/assemblage_etape_12.svg (100%) rename {docs/source => source}/img/assemblage_etape_13.svg (100%) rename {docs/source => source}/img/assemblage_etape_14.svg (100%) rename {docs/source => source}/img/assemblage_etape_15.svg (100%) rename {docs/source => source}/img/assemblage_etape_16.svg (100%) rename {docs/source => source}/img/assemblage_etape_17.svg (100%) rename {docs/source => source}/img/assemblage_etape_18.svg (100%) rename {docs/source => source}/img/assemblage_etape_19.svg (100%) rename {docs/source => source}/img/assemblage_etape_2.svg (100%) rename {docs/source => source}/img/assemblage_etape_20.svg (100%) rename {docs/source => source}/img/assemblage_etape_3.svg (100%) rename {docs/source => source}/img/assemblage_etape_4.svg (100%) rename {docs/source => source}/img/assemblage_etape_5.svg (100%) rename {docs/source => source}/img/assemblage_etape_6.svg (100%) rename {docs/source => source}/img/assemblage_etape_7.svg (100%) rename {docs/source => source}/img/assemblage_etape_8.svg (100%) rename {docs/source => source}/img/assemblage_etape_9.svg (100%) rename {docs/source => source}/img/assemblage_tube_tole.png (100%) rename {docs/source => source}/img/avant.png (100%) rename {docs/source => source}/img/capteur_vitesse.png (100%) rename {docs/source => source}/img/codification_nomenclature.png (100%) rename {docs/source => source}/img/cote_droit.png (100%) rename {docs/source => source}/img/cote_gauche.png (100%) rename {docs/source => source}/img/coupe_altimetrique.png (100%) rename {docs/source => source}/img/coupe_longitudinale.png (100%) rename {docs/source => source}/img/coupe_transversale_arriere.png (100%) rename {docs/source => source}/img/coupe_transversale_avant.png (100%) rename {docs/source => source}/img/dessous.png (100%) rename {docs/source => source}/img/dessus.png (100%) rename {docs/source => source}/img/div02.png (100%) rename {docs/source => source}/img/fixer_ch045_t16.png (100%) rename {docs/source => source}/img/moyeu_ca380.png (100%) rename {docs/source => source}/img/moyeu_nexus_8.png (100%) rename {docs/source => source}/img/photo_siege_dos.png (100%) rename {docs/source => source}/img/photo_tendeur_chaine.jpg (100%) rename {docs/source => source}/img/qin20.png (100%) rename {docs/source => source}/img/roue_nexus_8.png (100%) rename {docs/source => source}/img/schema_connexion_boitier_commodo.svg (100%) rename {docs/source => source}/img/schema_connexion_boitier_luminaire.svg (100%) rename {docs/source => source}/img/schema_connexion_boitier_moteur_batterie_solaire.svg (100%) rename {docs/source => source}/img/schema_connexion_commodo.svg (100%) rename {docs/source => source}/img/schema_connexion_moteur_batterie.svg (100%) rename {docs/source => source}/img/schema_connexion_moteur_batterie_integrale.svg (100%) rename {docs/source => source}/img/schema_connexion_moteur_batterie_panneau.svg (100%) rename {docs/source => source}/img/schema_connexion_panneau_integrale.svg (100%) rename {docs/source => source}/img/schema_connexion_platines_arriere.svg (100%) rename {docs/source => source}/img/schema_connexion_platines_avant.svg (100%) rename {docs/source => source}/img/tube_deforme.jpg (100%) rename {docs/source => source}/img/vhelio.png (100%) rename {docs/source => source}/img/vhelio_logo.png (100%) rename {docs/source => source}/img/vis_desserree_poignee.jpg (100%) rename {docs/source => source}/img/vis_serree_poignee.jpg (100%) rename {docs/source => source}/img/vue_3d_ch004.png (100%) rename {docs/source => source}/img/vue_3d_ch045.png (100%) rename {docs/source => source}/img/vue_3d_ch047.png (100%) rename {docs/source => source}/img/vue_3d_siege.png (100%) rename {docs/source => source}/img/vue_3d_siege_coupe.png (100%) rename {docs/source => source}/img/vue_3d_tendeur_chaine.png (100%) rename {docs/source => source}/img/vue_coupe_ch045.png (100%) rename {docs/source => source}/img/vue_coupe_ch047.png (100%) rename {docs/source => source}/index.md (99%) rename {docs/source => source}/installation_electricite.md (100%) rename {docs/source => source}/installation_textiles.md (100%) rename {docs/source => source}/montage_pieces_cycles.md (100%) rename {docs/source => source}/moyens_necessaires.md (100%) rename {docs/source => source}/plan_general.md (100%) rename {docs/source => source}/sieges.md (100%) rename {docs/source => source}/stabilisateurs.md (100%) rename {docs/source => source}/tests_verifications.md (100%) diff --git a/.gitignore b/.gitignore index a9b7dc7..c00f4c8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,156 +1,3 @@ +/outils +/build -# Created by https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks -# Edit at https://www.toptal.com/developers/gitignore?templates=python,jupyternotebooks - -### JupyterNotebooks ### -# gitignore template for Jupyter Notebooks -# website: http://jupyter.org/ - -.ipynb_checkpoints -*/.ipynb_checkpoints/* - -# IPython -profile_default/ -ipython_config.py - -# Remove previous ipynb_checkpoints -# git rm -r .ipynb_checkpoints/ - -### Python ### -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ -cover/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -.pybuilder/ -target/ - -# Jupyter Notebook - -# IPython - -# pyenv -# For a library or package, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# .python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# pytype static type analyzer -.pytype/ - -# Cython debug symbols -cython_debug/ - -# End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index db9e181..0000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,11 +0,0 @@ -version: 2 - -# Optionally declare the Python requirements required to build your docs -python: - install: - - requirements: docs/requirements.txt - -sphinx: - builder: html - configuration: docs/source/conf.py - fail_on_warning: true \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dbbff58 --- /dev/null +++ b/LICENSE @@ -0,0 +1,290 @@ +CERN Open Hardware Licence Version 2 - Strongly Reciprocal + + +Preamble + +CERN has developed this licence to promote collaboration among +hardware designers and to provide a legal tool which supports the +freedom to use, study, modify, share and distribute hardware designs +and products based on those designs. Version 2 of the CERN Open +Hardware Licence comes in three variants: CERN-OHL-P (permissive); and +two reciprocal licences: CERN-OHL-W (weakly reciprocal) and this +licence, CERN-OHL-S (strongly reciprocal). + +The CERN-OHL-S is copyright CERN 2020. Anyone is welcome to use it, in +unmodified form only. + +Use of this Licence does not imply any endorsement by CERN of any +Licensor or their designs nor does it imply any involvement by CERN in +their development. + + +1 Definitions + + 1.1 'Licence' means this CERN-OHL-S. + + 1.2 'Compatible Licence' means + + a) any earlier version of the CERN Open Hardware licence, or + + b) any version of the CERN-OHL-S, or + + c) any licence which permits You to treat the Source to which + it applies as licensed under CERN-OHL-S provided that on + Conveyance of any such Source, or any associated Product You + treat the Source in question as being licensed under + CERN-OHL-S. + + 1.3 'Source' means information such as design materials or digital + code which can be applied to Make or test a Product or to + prepare a Product for use, Conveyance or sale, regardless of its + medium or how it is expressed. It may include Notices. + + 1.4 'Covered Source' means Source that is explicitly made available + under this Licence. + + 1.5 'Product' means any device, component, work or physical object, + whether in finished or intermediate form, arising from the use, + application or processing of Covered Source. + + 1.6 'Make' means to create or configure something, whether by + manufacture, assembly, compiling, loading or applying Covered + Source or another Product or otherwise. + + 1.7 'Available Component' means any part, sub-assembly, library or + code which: + + a) is licensed to You as Complete Source under a Compatible + Licence; or + + b) is available, at the time a Product or the Source containing + it is first Conveyed, to You and any other prospective + licensees + + i) as a physical part with sufficient rights and + information (including any configuration and + programming files and information about its + characteristics and interfaces) to enable it either to + be Made itself, or to be sourced and used to Make the + Product; or + ii) as part of the normal distribution of a tool used to + design or Make the Product. + + 1.8 'Complete Source' means the set of all Source necessary to Make + a Product, in the preferred form for making modifications, + including necessary installation and interfacing information + both for the Product, and for any included Available Components. + If the format is proprietary, it must also be made available in + a format (if the proprietary tool can create it) which is + viewable with a tool available to potential licensees and + licensed under a licence approved by the Free Software + Foundation or the Open Source Initiative. Complete Source need + not include the Source of any Available Component, provided that + You include in the Complete Source sufficient information to + enable a recipient to Make or source and use the Available + Component to Make the Product. + + 1.9 'Source Location' means a location where a Licensor has placed + Covered Source, and which that Licensor reasonably believes will + remain easily accessible for at least three years for anyone to + obtain a digital copy. + + 1.10 'Notice' means copyright, acknowledgement and trademark notices, + Source Location references, modification notices (subsection + 3.3(b)) and all notices that refer to this Licence and to the + disclaimer of warranties that are included in the Covered + Source. + + 1.11 'Licensee' or 'You' means any person exercising rights under + this Licence. + + 1.12 'Licensor' means a natural or legal person who creates or + modifies Covered Source. A person may be a Licensee and a + Licensor at the same time. + + 1.13 'Convey' means to communicate to the public or distribute. + + +2 Applicability + + 2.1 This Licence governs the use, copying, modification, Conveying + of Covered Source and Products, and the Making of Products. By + exercising any right granted under this Licence, You irrevocably + accept these terms and conditions. + + 2.2 This Licence is granted by the Licensor directly to You, and + shall apply worldwide and without limitation in time. + + 2.3 You shall not attempt to restrict by contract or otherwise the + rights granted under this Licence to other Licensees. + + 2.4 This Licence is not intended to restrict fair use, fair dealing, + or any other similar right. + + +3 Copying, modifying and Conveying Covered Source + + 3.1 You may copy and Convey verbatim copies of Covered Source, in + any medium, provided You retain all Notices. + + 3.2 You may modify Covered Source, other than Notices, provided that + You irrevocably undertake to make that modified Covered Source + available from a Source Location should You Convey a Product in + circumstances where the recipient does not otherwise receive a + copy of the modified Covered Source. In each case subsection 3.3 + shall apply. + + You may only delete Notices if they are no longer applicable to + the corresponding Covered Source as modified by You and You may + add additional Notices applicable to Your modifications. + Including Covered Source in a larger work is modifying the + Covered Source, and the larger work becomes modified Covered + Source. + + 3.3 You may Convey modified Covered Source (with the effect that You + shall also become a Licensor) provided that You: + + a) retain Notices as required in subsection 3.2; + + b) add a Notice to the modified Covered Source stating that You + have modified it, with the date and brief description of how + You have modified it; + + c) add a Source Location Notice for the modified Covered Source + if You Convey in circumstances where the recipient does not + otherwise receive a copy of the modified Covered Source; and + + d) license the modified Covered Source under the terms and + conditions of this Licence (or, as set out in subsection + 8.3, a later version, if permitted by the licence of the + original Covered Source). Such modified Covered Source must + be licensed as a whole, but excluding Available Components + contained in it, which remain licensed under their own + applicable licences. + + +4 Making and Conveying Products + +You may Make Products, and/or Convey them, provided that You either +provide each recipient with a copy of the Complete Source or ensure +that each recipient is notified of the Source Location of the Complete +Source. That Complete Source is Covered Source, and You must +accordingly satisfy Your obligations set out in subsection 3.3. If +specified in a Notice, the Product must visibly and securely display +the Source Location on it or its packaging or documentation in the +manner specified in that Notice. + + +5 Research and Development + +You may Convey Covered Source, modified Covered Source or Products to +a legal entity carrying out development, testing or quality assurance +work on Your behalf provided that the work is performed on terms which +prevent the entity from both using the Source or Products for its own +internal purposes and Conveying the Source or Products or any +modifications to them to any person other than You. Any modifications +made by the entity shall be deemed to be made by You pursuant to +subsection 3.2. + + +6 DISCLAIMER AND LIABILITY + + 6.1 DISCLAIMER OF WARRANTY -- The Covered Source and any Products + are provided 'as is' and any express or implied warranties, + including, but not limited to, implied warranties of + merchantability, of satisfactory quality, non-infringement of + third party rights, and fitness for a particular purpose or use + are disclaimed in respect of any Source or Product to the + maximum extent permitted by law. The Licensor makes no + representation that any Source or Product does not or will not + infringe any patent, copyright, trade secret or other + proprietary right. The entire risk as to the use, quality, and + performance of any Source or Product shall be with You and not + the Licensor. This disclaimer of warranty is an essential part + of this Licence and a condition for the grant of any rights + granted under this Licence. + + 6.2 EXCLUSION AND LIMITATION OF LIABILITY -- The Licensor shall, to + the maximum extent permitted by law, have no liability for + direct, indirect, special, incidental, consequential, exemplary, + punitive or other damages of any character including, without + limitation, procurement of substitute goods or services, loss of + use, data or profits, or business interruption, however caused + and on any theory of contract, warranty, tort (including + negligence), product liability or otherwise, arising in any way + in relation to the Covered Source, modified Covered Source + and/or the Making or Conveyance of a Product, even if advised of + the possibility of such damages, and You shall hold the + Licensor(s) free and harmless from any liability, costs, + damages, fees and expenses, including claims by third parties, + in relation to such use. + + +7 Patents + + 7.1 Subject to the terms and conditions of this Licence, each + Licensor hereby grants to You a perpetual, worldwide, + non-exclusive, no-charge, royalty-free, irrevocable (except as + stated in subsections 7.2 and 8.4) patent license to Make, have + Made, use, offer to sell, sell, import, and otherwise transfer + the Covered Source and Products, where such licence applies only + to those patent claims licensable by such Licensor that are + necessarily infringed by exercising rights under the Covered + Source as Conveyed by that Licensor. + + 7.2 If You institute patent litigation against any entity (including + a cross-claim or counterclaim in a lawsuit) alleging that the + Covered Source or a Product constitutes direct or contributory + patent infringement, or You seek any declaration that a patent + licensed to You under this Licence is invalid or unenforceable + then any rights granted to You under this Licence shall + terminate as of the date such process is initiated. + + +8 General + + 8.1 If any provisions of this Licence are or subsequently become + invalid or unenforceable for any reason, the remaining + provisions shall remain effective. + + 8.2 You shall not use any of the name (including acronyms and + abbreviations), image, or logo by which the Licensor or CERN is + known, except where needed to comply with section 3, or where + the use is otherwise allowed by law. Any such permitted use + shall be factual and shall not be made so as to suggest any kind + of endorsement or implication of involvement by the Licensor or + its personnel. + + 8.3 CERN may publish updated versions and variants of this Licence + which it considers to be in the spirit of this version, but may + differ in detail to address new problems or concerns. New + versions will be published with a unique version number and a + variant identifier specifying the variant. If the Licensor has + specified that a given variant applies to the Covered Source + without specifying a version, You may treat that Covered Source + as being released under any version of the CERN-OHL with that + variant. If no variant is specified, the Covered Source shall be + treated as being released under CERN-OHL-S. The Licensor may + also specify that the Covered Source is subject to a specific + version of the CERN-OHL or any later version in which case You + may apply this or any later version of CERN-OHL with the same + variant identifier published by CERN. + + 8.4 This Licence shall terminate with immediate effect if You fail + to comply with any of its terms and conditions. + + 8.5 However, if You cease all breaches of this Licence, then Your + Licence from any Licensor is reinstated unless such Licensor has + terminated this Licence by giving You, while You remain in + breach, a notice specifying the breach and requiring You to cure + it within 30 days, and You have failed to come into compliance + in all material respects by the end of the 30 day period. Should + You repeat the breach after receipt of a cure notice and + subsequent reinstatement, this Licence will terminate + immediately and permanently. Section 6 shall continue to apply + after any termination. + + 8.6 This Licence shall not be enforceable except by a Licensor + acting as such, and third party beneficiary rights are + specifically excluded. + diff --git a/docs/Makefile b/Makefile similarity index 100% rename from docs/Makefile rename to Makefile diff --git a/README.md b/README.md index f16c91f..cae8443 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ -Documentation du Vhéliotech -======================================= +Documentation du vhéliotech +=========================== -Ce dépôt est un test de documentation collaborative pour le Vhéliotech. +/!\ Important : ceci est une version de travail, vous trouverez la documentation officielle du vhéliotech à cette adresse : https://communaute.vhelio.org/d/4-documentation-du-vheliotech-indice-001-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 -:::: \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index b93c70a..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -myst-parser -linkify-it-py \ No newline at end of file diff --git a/docs/make.bat b/make.bat similarity index 100% rename from docs/make.bat rename to make.bat diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index 653ddfc..0000000 --- a/pyproject.toml +++ /dev/null @@ -1,8 +0,0 @@ -[build-system] -requires = ["flit_core >=3.2,<4", "myst-parser"] -build-backend = "flit_core.buildapi" - -[project] -name = "vheliotech" -authors = [{name = "Velo solaire pour tous", email = "contact@vhelio.org"}] -dynamic = ["version", "description"] diff --git a/docs/source/accessoires.md b/source/accessoires.md similarity index 100% rename from docs/source/accessoires.md rename to source/accessoires.md diff --git a/docs/source/assemblage_chassis_toit.md b/source/assemblage_chassis_toit.md similarity index 100% rename from docs/source/assemblage_chassis_toit.md rename to source/assemblage_chassis_toit.md diff --git a/docs/source/conf.py b/source/conf.py similarity index 96% rename from docs/source/conf.py rename to source/conf.py index da1b2e3..394906d 100644 --- a/docs/source/conf.py +++ b/source/conf.py @@ -18,6 +18,7 @@ extensions = [ 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', 'myst_parser', + 'sphinxcontrib.inkscapeconverter', ] myst_enable_extensions = [ diff --git a/docs/source/documentation.md b/source/documentation.md similarity index 100% rename from docs/source/documentation.md rename to source/documentation.md diff --git a/docs/source/img/arriere.png b/source/img/arriere.png similarity index 100% rename from docs/source/img/arriere.png rename to source/img/arriere.png diff --git a/docs/source/img/assemblage_2_toles.png b/source/img/assemblage_2_toles.png similarity index 100% rename from docs/source/img/assemblage_2_toles.png rename to source/img/assemblage_2_toles.png diff --git a/docs/source/img/assemblage_2_tubes.png b/source/img/assemblage_2_tubes.png similarity index 100% rename from docs/source/img/assemblage_2_tubes.png rename to source/img/assemblage_2_tubes.png diff --git a/docs/source/img/assemblage_3_tubes.png b/source/img/assemblage_3_tubes.png similarity index 100% rename from docs/source/img/assemblage_3_tubes.png rename to source/img/assemblage_3_tubes.png diff --git a/docs/source/img/assemblage_etape_1.png b/source/img/assemblage_etape_1.png similarity index 100% rename from docs/source/img/assemblage_etape_1.png rename to source/img/assemblage_etape_1.png diff --git a/docs/source/img/assemblage_etape_1.svg b/source/img/assemblage_etape_1.svg similarity index 100% rename from docs/source/img/assemblage_etape_1.svg rename to source/img/assemblage_etape_1.svg diff --git a/docs/source/img/assemblage_etape_10.svg b/source/img/assemblage_etape_10.svg similarity index 100% rename from docs/source/img/assemblage_etape_10.svg rename to source/img/assemblage_etape_10.svg diff --git a/docs/source/img/assemblage_etape_11.svg b/source/img/assemblage_etape_11.svg similarity index 100% rename from docs/source/img/assemblage_etape_11.svg rename to source/img/assemblage_etape_11.svg diff --git a/docs/source/img/assemblage_etape_12.svg b/source/img/assemblage_etape_12.svg similarity index 100% rename from docs/source/img/assemblage_etape_12.svg rename to source/img/assemblage_etape_12.svg diff --git a/docs/source/img/assemblage_etape_13.svg b/source/img/assemblage_etape_13.svg similarity index 100% rename from docs/source/img/assemblage_etape_13.svg rename to source/img/assemblage_etape_13.svg diff --git a/docs/source/img/assemblage_etape_14.svg b/source/img/assemblage_etape_14.svg similarity index 100% rename from docs/source/img/assemblage_etape_14.svg rename to source/img/assemblage_etape_14.svg diff --git a/docs/source/img/assemblage_etape_15.svg b/source/img/assemblage_etape_15.svg similarity index 100% rename from docs/source/img/assemblage_etape_15.svg rename to source/img/assemblage_etape_15.svg diff --git a/docs/source/img/assemblage_etape_16.svg b/source/img/assemblage_etape_16.svg similarity index 100% rename from docs/source/img/assemblage_etape_16.svg rename to source/img/assemblage_etape_16.svg diff --git a/docs/source/img/assemblage_etape_17.svg b/source/img/assemblage_etape_17.svg similarity index 100% rename from docs/source/img/assemblage_etape_17.svg rename to source/img/assemblage_etape_17.svg diff --git a/docs/source/img/assemblage_etape_18.svg b/source/img/assemblage_etape_18.svg similarity index 100% rename from docs/source/img/assemblage_etape_18.svg rename to source/img/assemblage_etape_18.svg diff --git a/docs/source/img/assemblage_etape_19.svg b/source/img/assemblage_etape_19.svg similarity index 100% rename from docs/source/img/assemblage_etape_19.svg rename to source/img/assemblage_etape_19.svg diff --git a/docs/source/img/assemblage_etape_2.svg b/source/img/assemblage_etape_2.svg similarity index 100% rename from docs/source/img/assemblage_etape_2.svg rename to source/img/assemblage_etape_2.svg diff --git a/docs/source/img/assemblage_etape_20.svg b/source/img/assemblage_etape_20.svg similarity index 100% rename from docs/source/img/assemblage_etape_20.svg rename to source/img/assemblage_etape_20.svg diff --git a/docs/source/img/assemblage_etape_3.svg b/source/img/assemblage_etape_3.svg similarity index 100% rename from docs/source/img/assemblage_etape_3.svg rename to source/img/assemblage_etape_3.svg diff --git a/docs/source/img/assemblage_etape_4.svg b/source/img/assemblage_etape_4.svg similarity index 100% rename from docs/source/img/assemblage_etape_4.svg rename to source/img/assemblage_etape_4.svg diff --git a/docs/source/img/assemblage_etape_5.svg b/source/img/assemblage_etape_5.svg similarity index 100% rename from docs/source/img/assemblage_etape_5.svg rename to source/img/assemblage_etape_5.svg diff --git a/docs/source/img/assemblage_etape_6.svg b/source/img/assemblage_etape_6.svg similarity index 100% rename from docs/source/img/assemblage_etape_6.svg rename to source/img/assemblage_etape_6.svg diff --git a/docs/source/img/assemblage_etape_7.svg b/source/img/assemblage_etape_7.svg similarity index 100% rename from docs/source/img/assemblage_etape_7.svg rename to source/img/assemblage_etape_7.svg diff --git a/docs/source/img/assemblage_etape_8.svg b/source/img/assemblage_etape_8.svg similarity index 100% rename from docs/source/img/assemblage_etape_8.svg rename to source/img/assemblage_etape_8.svg diff --git a/docs/source/img/assemblage_etape_9.svg b/source/img/assemblage_etape_9.svg similarity index 100% rename from docs/source/img/assemblage_etape_9.svg rename to source/img/assemblage_etape_9.svg diff --git a/docs/source/img/assemblage_tube_tole.png b/source/img/assemblage_tube_tole.png similarity index 100% rename from docs/source/img/assemblage_tube_tole.png rename to source/img/assemblage_tube_tole.png diff --git a/docs/source/img/avant.png b/source/img/avant.png similarity index 100% rename from docs/source/img/avant.png rename to source/img/avant.png diff --git a/docs/source/img/capteur_vitesse.png b/source/img/capteur_vitesse.png similarity index 100% rename from docs/source/img/capteur_vitesse.png rename to source/img/capteur_vitesse.png diff --git a/docs/source/img/codification_nomenclature.png b/source/img/codification_nomenclature.png similarity index 100% rename from docs/source/img/codification_nomenclature.png rename to source/img/codification_nomenclature.png diff --git a/docs/source/img/cote_droit.png b/source/img/cote_droit.png similarity index 100% rename from docs/source/img/cote_droit.png rename to source/img/cote_droit.png diff --git a/docs/source/img/cote_gauche.png b/source/img/cote_gauche.png similarity index 100% rename from docs/source/img/cote_gauche.png rename to source/img/cote_gauche.png diff --git a/docs/source/img/coupe_altimetrique.png b/source/img/coupe_altimetrique.png similarity index 100% rename from docs/source/img/coupe_altimetrique.png rename to source/img/coupe_altimetrique.png diff --git a/docs/source/img/coupe_longitudinale.png b/source/img/coupe_longitudinale.png similarity index 100% rename from docs/source/img/coupe_longitudinale.png rename to source/img/coupe_longitudinale.png diff --git a/docs/source/img/coupe_transversale_arriere.png b/source/img/coupe_transversale_arriere.png similarity index 100% rename from docs/source/img/coupe_transversale_arriere.png rename to source/img/coupe_transversale_arriere.png diff --git a/docs/source/img/coupe_transversale_avant.png b/source/img/coupe_transversale_avant.png similarity index 100% rename from docs/source/img/coupe_transversale_avant.png rename to source/img/coupe_transversale_avant.png diff --git a/docs/source/img/dessous.png b/source/img/dessous.png similarity index 100% rename from docs/source/img/dessous.png rename to source/img/dessous.png diff --git a/docs/source/img/dessus.png b/source/img/dessus.png similarity index 100% rename from docs/source/img/dessus.png rename to source/img/dessus.png diff --git a/docs/source/img/div02.png b/source/img/div02.png similarity index 100% rename from docs/source/img/div02.png rename to source/img/div02.png diff --git a/docs/source/img/fixer_ch045_t16.png b/source/img/fixer_ch045_t16.png similarity index 100% rename from docs/source/img/fixer_ch045_t16.png rename to source/img/fixer_ch045_t16.png diff --git a/docs/source/img/moyeu_ca380.png b/source/img/moyeu_ca380.png similarity index 100% rename from docs/source/img/moyeu_ca380.png rename to source/img/moyeu_ca380.png diff --git a/docs/source/img/moyeu_nexus_8.png b/source/img/moyeu_nexus_8.png similarity index 100% rename from docs/source/img/moyeu_nexus_8.png rename to source/img/moyeu_nexus_8.png diff --git a/docs/source/img/photo_siege_dos.png b/source/img/photo_siege_dos.png similarity index 100% rename from docs/source/img/photo_siege_dos.png rename to source/img/photo_siege_dos.png diff --git a/docs/source/img/photo_tendeur_chaine.jpg b/source/img/photo_tendeur_chaine.jpg similarity index 100% rename from docs/source/img/photo_tendeur_chaine.jpg rename to source/img/photo_tendeur_chaine.jpg diff --git a/docs/source/img/qin20.png b/source/img/qin20.png similarity index 100% rename from docs/source/img/qin20.png rename to source/img/qin20.png diff --git a/docs/source/img/roue_nexus_8.png b/source/img/roue_nexus_8.png similarity index 100% rename from docs/source/img/roue_nexus_8.png rename to source/img/roue_nexus_8.png diff --git a/docs/source/img/schema_connexion_boitier_commodo.svg b/source/img/schema_connexion_boitier_commodo.svg similarity index 100% rename from docs/source/img/schema_connexion_boitier_commodo.svg rename to source/img/schema_connexion_boitier_commodo.svg diff --git a/docs/source/img/schema_connexion_boitier_luminaire.svg b/source/img/schema_connexion_boitier_luminaire.svg similarity index 100% rename from docs/source/img/schema_connexion_boitier_luminaire.svg rename to source/img/schema_connexion_boitier_luminaire.svg diff --git a/docs/source/img/schema_connexion_boitier_moteur_batterie_solaire.svg b/source/img/schema_connexion_boitier_moteur_batterie_solaire.svg similarity index 100% rename from docs/source/img/schema_connexion_boitier_moteur_batterie_solaire.svg rename to source/img/schema_connexion_boitier_moteur_batterie_solaire.svg diff --git a/docs/source/img/schema_connexion_commodo.svg b/source/img/schema_connexion_commodo.svg similarity index 100% rename from docs/source/img/schema_connexion_commodo.svg rename to source/img/schema_connexion_commodo.svg diff --git a/docs/source/img/schema_connexion_moteur_batterie.svg b/source/img/schema_connexion_moteur_batterie.svg similarity index 100% rename from docs/source/img/schema_connexion_moteur_batterie.svg rename to source/img/schema_connexion_moteur_batterie.svg diff --git a/docs/source/img/schema_connexion_moteur_batterie_integrale.svg b/source/img/schema_connexion_moteur_batterie_integrale.svg similarity index 100% rename from docs/source/img/schema_connexion_moteur_batterie_integrale.svg rename to source/img/schema_connexion_moteur_batterie_integrale.svg diff --git a/docs/source/img/schema_connexion_moteur_batterie_panneau.svg b/source/img/schema_connexion_moteur_batterie_panneau.svg similarity index 100% rename from docs/source/img/schema_connexion_moteur_batterie_panneau.svg rename to source/img/schema_connexion_moteur_batterie_panneau.svg diff --git a/docs/source/img/schema_connexion_panneau_integrale.svg b/source/img/schema_connexion_panneau_integrale.svg similarity index 100% rename from docs/source/img/schema_connexion_panneau_integrale.svg rename to source/img/schema_connexion_panneau_integrale.svg diff --git a/docs/source/img/schema_connexion_platines_arriere.svg b/source/img/schema_connexion_platines_arriere.svg similarity index 100% rename from docs/source/img/schema_connexion_platines_arriere.svg rename to source/img/schema_connexion_platines_arriere.svg diff --git a/docs/source/img/schema_connexion_platines_avant.svg b/source/img/schema_connexion_platines_avant.svg similarity index 100% rename from docs/source/img/schema_connexion_platines_avant.svg rename to source/img/schema_connexion_platines_avant.svg diff --git a/docs/source/img/tube_deforme.jpg b/source/img/tube_deforme.jpg similarity index 100% rename from docs/source/img/tube_deforme.jpg rename to source/img/tube_deforme.jpg diff --git a/docs/source/img/vhelio.png b/source/img/vhelio.png similarity index 100% rename from docs/source/img/vhelio.png rename to source/img/vhelio.png diff --git a/docs/source/img/vhelio_logo.png b/source/img/vhelio_logo.png similarity index 100% rename from docs/source/img/vhelio_logo.png rename to source/img/vhelio_logo.png diff --git a/docs/source/img/vis_desserree_poignee.jpg b/source/img/vis_desserree_poignee.jpg similarity index 100% rename from docs/source/img/vis_desserree_poignee.jpg rename to source/img/vis_desserree_poignee.jpg diff --git a/docs/source/img/vis_serree_poignee.jpg b/source/img/vis_serree_poignee.jpg similarity index 100% rename from docs/source/img/vis_serree_poignee.jpg rename to source/img/vis_serree_poignee.jpg diff --git a/docs/source/img/vue_3d_ch004.png b/source/img/vue_3d_ch004.png similarity index 100% rename from docs/source/img/vue_3d_ch004.png rename to source/img/vue_3d_ch004.png diff --git a/docs/source/img/vue_3d_ch045.png b/source/img/vue_3d_ch045.png similarity index 100% rename from docs/source/img/vue_3d_ch045.png rename to source/img/vue_3d_ch045.png diff --git a/docs/source/img/vue_3d_ch047.png b/source/img/vue_3d_ch047.png similarity index 100% rename from docs/source/img/vue_3d_ch047.png rename to source/img/vue_3d_ch047.png diff --git a/docs/source/img/vue_3d_siege.png b/source/img/vue_3d_siege.png similarity index 100% rename from docs/source/img/vue_3d_siege.png rename to source/img/vue_3d_siege.png diff --git a/docs/source/img/vue_3d_siege_coupe.png b/source/img/vue_3d_siege_coupe.png similarity index 100% rename from docs/source/img/vue_3d_siege_coupe.png rename to source/img/vue_3d_siege_coupe.png diff --git a/docs/source/img/vue_3d_tendeur_chaine.png b/source/img/vue_3d_tendeur_chaine.png similarity index 100% rename from docs/source/img/vue_3d_tendeur_chaine.png rename to source/img/vue_3d_tendeur_chaine.png diff --git a/docs/source/img/vue_coupe_ch045.png b/source/img/vue_coupe_ch045.png similarity index 100% rename from docs/source/img/vue_coupe_ch045.png rename to source/img/vue_coupe_ch045.png diff --git a/docs/source/img/vue_coupe_ch047.png b/source/img/vue_coupe_ch047.png similarity index 100% rename from docs/source/img/vue_coupe_ch047.png rename to source/img/vue_coupe_ch047.png diff --git a/docs/source/index.md b/source/index.md similarity index 99% rename from docs/source/index.md rename to source/index.md index 3313cb2..b1a03bd 100644 --- a/docs/source/index.md +++ b/source/index.md @@ -30,9 +30,6 @@ Le nom de marque vhélio ne peut être utilisé sans autorisation de l’associa Copyright Vélo Solaire Pour Tous, Mars 2022, sous licence CERN-OHL-S version 2 -## Contents - - ```{toctree} documentation moyens_necessaires diff --git a/docs/source/installation_electricite.md b/source/installation_electricite.md similarity index 100% rename from docs/source/installation_electricite.md rename to source/installation_electricite.md diff --git a/docs/source/installation_textiles.md b/source/installation_textiles.md similarity index 100% rename from docs/source/installation_textiles.md rename to source/installation_textiles.md diff --git a/docs/source/montage_pieces_cycles.md b/source/montage_pieces_cycles.md similarity index 100% rename from docs/source/montage_pieces_cycles.md rename to source/montage_pieces_cycles.md diff --git a/docs/source/moyens_necessaires.md b/source/moyens_necessaires.md similarity index 100% rename from docs/source/moyens_necessaires.md rename to source/moyens_necessaires.md diff --git a/docs/source/plan_general.md b/source/plan_general.md similarity index 100% rename from docs/source/plan_general.md rename to source/plan_general.md diff --git a/docs/source/sieges.md b/source/sieges.md similarity index 100% rename from docs/source/sieges.md rename to source/sieges.md diff --git a/docs/source/stabilisateurs.md b/source/stabilisateurs.md similarity index 100% rename from docs/source/stabilisateurs.md rename to source/stabilisateurs.md diff --git a/docs/source/tests_verifications.md b/source/tests_verifications.md similarity index 100% rename from docs/source/tests_verifications.md rename to source/tests_verifications.md