mirror of
https://github.com/ae-utbm/sith.git
synced 2024-11-22 14:13:21 +00:00
documentation: add instructions for direnv
This commit is contained in:
parent
5c3c14ab37
commit
a766f7137c
@ -52,6 +52,7 @@ Bienvenue sur la documentation du Sith de l'AE
|
|||||||
|
|
||||||
misc/md_syntax
|
misc/md_syntax
|
||||||
misc/helpers
|
misc/helpers
|
||||||
|
misc/direnv
|
||||||
misc/prod
|
misc/prod
|
||||||
|
|
||||||
Documentations complémentaires
|
Documentations complémentaires
|
||||||
|
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.
|
@ -51,6 +51,10 @@ Installer le projet
|
|||||||
# Prépare la base de donnée
|
# Prépare la base de donnée
|
||||||
./manage.py setup
|
./manage.py setup
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Pour éviter d'avoir à utiliser la commande source sur le virtualenv systématiquement, il est possible de consulter :ref:`direnv`.
|
||||||
|
|
||||||
Configuration pour le développement
|
Configuration pour le développement
|
||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user