Verified Commit a6c8dea1 authored by Sli's avatar Sli
Browse files

documentation: move markdown syntax documentation and move helper for counting lines

parent 124eaf42
......@@ -76,18 +76,3 @@ Now you have many solutions in your model:
Finally, when building a class based view, which is highly advised, you just have to inherit it from CanEditPropMixin,
CanEditMixin, or CanViewMixin, which are located in core.views. Your view will then be protected using either the
appropriate group fields, or the right method to check user permissions.
Counting the number of line of code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. sourcecode:: bash
sudo apt install cloc
cloc --exclude-dir=doc,env .
Updating doc/SYNTAX.md
~~~~~~~~~~~~~~~~~~~~~~
| If you make an update in the Markdown syntax parser, it's good to document update the syntax reference page in :bash:`doc/SYNTAX.md`. But updating this file will break the tests if you don't update the corresponding :bash:`doc/SYNTAX.html` file at the same time.
| To do that, simply run :bash:`./manage.py markdown > doc/SYNTAX.html`,
and the tests should pass again.
......@@ -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
-------------------------
......
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 .
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
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment