mirror of
https://github.com/ae-utbm/sith.git
synced 2025-07-09 19:40:19 +00:00
documentation: move markdown syntax documentation and move helper for counting lines
This commit is contained in:
@ -38,6 +38,7 @@ Bienvenue sur la documentation du Sith de l'AE
|
||||
:maxdepth: 2
|
||||
:caption: Divers
|
||||
|
||||
misc/md_syntax
|
||||
misc/helpers
|
||||
|
||||
Documentations complémentaires
|
||||
@ -68,8 +69,6 @@ Git
|
||||
* `Livre sur Git <http://www.git-scm.com/book/fr/v2>`__
|
||||
|
||||
|
||||
|
||||
|
||||
Documents téléchargeables
|
||||
-------------------------
|
||||
|
||||
|
@ -1,8 +1,17 @@
|
||||
Commandes utiles
|
||||
================
|
||||
|
||||
* Appliquer le header de licence sur tout le projet
|
||||
Appliquer le header de licence sur tout le projet
|
||||
-------------------------------------------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
for f in $(find . -name "*.py" ! -path "*migration*" ! -path "./env/*" ! -path "./doc/*"); do cat ./doc/header "$f" > /tmp/temp && mv /tmp/temp "$f"; done
|
||||
|
||||
Compter le nombre de lignes de code
|
||||
-----------------------------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt install cloc
|
||||
cloc --exclude-dir=doc,env .
|
||||
|
20
doc/misc/md_syntax.rst
Normal file
20
doc/misc/md_syntax.rst
Normal file
@ -0,0 +1,20 @@
|
||||
Syntaxe markdown utilisée dans le site
|
||||
======================================
|
||||
|
||||
.. note::
|
||||
|
||||
Si vous faites une mise à jour sur le parseur markdown, il est bon de documenter cette mise à jour dans la page de référence *doc/SYNTAX.md*. Mettre à jour ce fichier vas casser les tests si vous ne mettez pas à jour le fichier *doc/SYNTAX.md* qui lui correspond juste après. Pour mettre à jour ce fichier il suffit d'utiliser la commande
|
||||
|
||||
::
|
||||
|
||||
./manage.py markdown > doc/SYNTAX.html
|
||||
|
||||
.. warning::
|
||||
|
||||
Le rendu de cette aide est fait via Sphinx, il peut représenter quelques différences avec la réalité. Il est possible de télécharger juste en dessous les versions brutes.
|
||||
|
||||
* :download:`Fichier d'aide en markdown <../SYNTAX.md>`
|
||||
* :download:`Fichier d'aide rendu en HTML <../SYNTAX.html>`
|
||||
|
||||
.. raw:: html
|
||||
:file: ../SYNTAX.html
|
Reference in New Issue
Block a user