mirror of
https://github.com/ae-utbm/sith.git
synced 2025-07-11 20:39:23 +00:00
Revert "Cleaned doc folder as it was unused"
This reverts commit 8716f2a01e
.
This commit is contained in:
31
doc/misc/direnv.rst
Normal file
31
doc/misc/direnv.rst
Normal file
@ -0,0 +1,31 @@
|
||||
.. _direnv:
|
||||
|
||||
Utiliser direnv
|
||||
===============
|
||||
|
||||
Pour éviter d'avoir à sourcer l'environnement à chaque fois qu'on rentre dans le projet, il est possible d'utiliser l'utilitaire `direnv <https://direnv.net/>`__.
|
||||
|
||||
.. sourcecode:: bash
|
||||
|
||||
# Installation de l'utilitaire
|
||||
|
||||
# Debian et Ubuntu
|
||||
sudo apt install direnv
|
||||
# Mac
|
||||
brew install direnv
|
||||
|
||||
|
||||
# Installation dans la config
|
||||
# Si sur bash
|
||||
echo 'eval "$(direnv hook bash)"' >> ~/.bashrc
|
||||
# Si sur ZSH
|
||||
echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc
|
||||
|
||||
exit # On redémarre le terminal
|
||||
|
||||
# Une fois dans le dossier du projet site AE
|
||||
direnv allow .
|
||||
|
||||
Une fois que cette configuration a été appliquée, aller dans le dossier du site applique automatiquement l'environnement virtuel, cela fait beaucoup moins de temps perdu pour tout le monde.
|
||||
|
||||
Direnv est un utilitaire très puissant et qui peut s'avérer pratique dans bien des situations, n'hésitez pas à aller vous renseigner plus en détail sur celui-ci.
|
17
doc/misc/helpers.rst
Normal file
17
doc/misc/helpers.rst
Normal file
@ -0,0 +1,17 @@
|
||||
Commandes utiles
|
||||
================
|
||||
|
||||
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.html* 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
|
21
doc/misc/prod.rst
Normal file
21
doc/misc/prod.rst
Normal file
@ -0,0 +1,21 @@
|
||||
Configurer pour la production
|
||||
=============================
|
||||
|
||||
Configurer Sentry
|
||||
-----------------
|
||||
|
||||
Pour connecter l'application à une instance de sentry (ex: https://sentry.io) il est nécessaire de configurer la variable **SENTRY_DSN** dans le fichier *settings_custom.py*. Cette variable est composée d'un lien complet vers votre projet sentry.
|
||||
|
||||
Récupérer les statiques
|
||||
-----------------------
|
||||
|
||||
Nous utilisons du SCSS dans le projet. En environnement de développement (DEBUG=True), le SCSS est compilé à chaque fois que le fichier est demandé. Pour la production, le projet considère que chacun des fichier est déjà compilé, et, pour ce faire, il est nécessaire d'utiliser les commandes suivantes dans l'ordre :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
./manage.py collectstatic # Pour récupérer tous les fichiers statiques
|
||||
./manage.py compilestatic # Pour compiler les fichiers SCSS qu'ils contiennent
|
||||
|
||||
.. note::
|
||||
|
||||
Le dossier où seront enregistrés ces fichiers statiques peut être changé en modifiant la variable *STATIC_ROOT* dans les paramètres.
|
Reference in New Issue
Block a user