mirror of
https://github.com/ae-utbm/sith.git
synced 2025-07-12 12:59:24 +00:00
documentation: remove CONTRIBUTING and migrate its content in the doc
This commit is contained in:
60
doc/start/devtools.rst
Normal file
60
doc/start/devtools.rst
Normal file
@ -0,0 +1,60 @@
|
||||
Configurer son environnement de développement
|
||||
=============================================
|
||||
|
||||
Le projet n'est en aucun cas lié à un quelconque environnement de développement. Il est possible pour chacun de travailler avec les outils dont il a envie et d'utiliser l'éditeur de code avec lequel il est le plus à l'aise.
|
||||
|
||||
Pour donner une idée, Skia a écrit une énorme partie de projet avec l'éditeur *vim* sur du GNU/Linux alors que Sli a utilisé *Sublime Text* sur MacOS.
|
||||
|
||||
Configurer Black pour son éditeur
|
||||
---------------------------------
|
||||
|
||||
Tous les détails concernant l'installation de black sont ici : https://black.readthedocs.io/en/stable/editor_integration.html
|
||||
|
||||
Néanmoins, nous tenterons de vous faire ici un résumé pour deux éditeurs de textes populaires que sont VsCode et Sublime Text.
|
||||
|
||||
.. sourcecode:: bash
|
||||
|
||||
# Installation de black
|
||||
pip install black
|
||||
|
||||
VsCode
|
||||
~~~~~~
|
||||
|
||||
.. warning::
|
||||
|
||||
Il faut installer black dans son virtualenv pour cet éditeur
|
||||
|
||||
Black est directement pris en charge par l'extension pour le Python de VsCode, il suffit de rentrer la configuration suivante :
|
||||
|
||||
.. sourcecode:: json
|
||||
|
||||
{
|
||||
"python.formatting.provider": "black",
|
||||
"editor.formatOnSave": true
|
||||
}
|
||||
|
||||
Sublime Text
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Il est tout d'abord nécessaire d'installer ce plugin : https://packagecontrol.io/packages/sublack.
|
||||
|
||||
Il suffit ensuite d'ajouter dans les settings du projet (ou directement dans les settings globales) :
|
||||
|
||||
.. sourcecode:: json
|
||||
|
||||
{
|
||||
"sublack.black_on_save": true
|
||||
}
|
||||
|
||||
Si vous utilisez le plugin `anaconda <http://damnwidget.github.io/anaconda/>`__, pensez à modifier les paramètres du linter pep8 pour éviter de recevoir des warnings dans le formatage de black comme ceci :
|
||||
|
||||
.. sourcecode:: json
|
||||
|
||||
{
|
||||
"pep8_ignore": [
|
||||
"E203",
|
||||
"E266",
|
||||
"E501",
|
||||
"W503"
|
||||
]
|
||||
}
|
Reference in New Issue
Block a user