First try

.github/workflows/documentation.yaml

@@ -0,0 +1,24 @@
+name: Docs
+on: [push, pull_request, workflow_dispatch]
+permissions:
+    contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme
+      - name: Sphinx build
+        run: |
+          sphinx-build doc _build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

doc/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)

doc/carte-mere-tri.md

@@ -0,0 +1,14 @@
+# Carte-mère triphasée
+
+## Subsection
+
+Exciting documentation in here.
+Let's make a list (empty surrounding lines required):
+
+- item 1
+
+  - nested item 1
+  - nested item 2
+
+- item 2
+- item 3

doc/conf.py

@@ -0,0 +1,37 @@
+# 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
+
+import sphinx_rtd_theme
+import myst_parser
+import sphinx.ext.mathjax
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Mk2PVRouter'
+copyright = '2023, ENERGIE ROUTER & F. Metrich (aka FredM67)'
+author = 'ENERGIE ROUTER & F. Metrich (aka FredM67)'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'myst_parser',
+    'sphinx.ext.mathjax',
+    'sphinx_rtd_theme',
+    'sphinx_copybutton',]
+
+source_suffix = ['.rst', '.md']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+language = 'fr'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

doc/index.rst

@@ -0,0 +1,14 @@
+.. Mk2PVRouter documentation master file, created by
+   sphinx-quickstart on Mon Aug 28 10:50:52 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Mk2PVRouter's documentation!
+=======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   introduction.md
+   carte-mere-tri.md

doc/introduction.md

@@ -0,0 +1,47 @@
+# Introduction
+
+## Contenu du kit
+
+Dans le kit, vous trouverez :
+- le circuit imprimé (PCB) de la carte-mère
+- un ou plusieurs circuits imprimés pour chaque sortie
+- des composants électroniques (résistances, condensateurs, ...). Attention, certains sont sensibles à l'électricité statique, il faut donc les manipuler avec soin
+- un boîtier
+- des câbles
+
+## Étapes d'assemblage
+
+L'assemblage complet va nécessité plusieurs étapes :
+- soudure et tests de la carte-mère
+- soudure et tests de la ou les cartes de sortie
+- perçage du boîtier
+- perçage du ou des dissipateurs thermiques
+- montage des circuits soudés dans le boîtier
+- confection des câbles
+- câblage
+- étalonnage
+- programmation finale
+
+## Conseils pour les étapes de soudure
+
+Les composants nécessaires sont très variés. Certains composants sont passifs (résistances, ...), d'autres sont actifs (AtMega, ...).
+D'une manière générale, il faut considérer que tous les composants sont sensibles à l'électricité statique.
+Il faut donc les manipuler avec soin, dans la mesure du possible, le corps humain doit être relié à la terre.
+
+Certains composants sont polarisés (diodes, certains condensateurs, ...), d'autres ne le sont pas (résistances, certains condensateurs). Faites très attention au sens AVANT de souder. Le sens est réparable directement sur la carte-mère.
+
+Ces composants sont aussi de tailles très différentes. Des plus petits, avec quelques millimètres d'épaisseur/diamètre aux plus gros avec plus centimètres d'épaisseur (transformateurs).
+
+Pour des raisons pratiques, il est conseillé de procéder strictement par ordre de taille.
+Ainsi, on soudera dans cet ordre :
+1. résistances et diodes, ponts le cas échéant
+2. supports IC1 et IC2 (voire IC3, IC4 selon le kit) (ne pas insérer les circuits intégrés dans les support)
+3. condensateurs "orange" non polarisés, oscillateur
+4. pont(s) de diodes
+5. tous les connecteurs SIL noirs et le connecteur d'affichage le cas échéant
+6. condensateurs polarisés (noir ou bleu)
+7. le(s) gros connecteur(s) haute tension
+8. le(s) porte-fusible
+9. enfin le(s) transformateur(s)
+
+Cet ordre précis permet de s'affranchir de tordre les pattes des composants, utiliser de l'adhésif, ...

doc/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd