diff --git a/.envrc b/.envrc new file mode 100644 index 00000000..d07b2249 --- /dev/null +++ b/.envrc @@ -0,0 +1 @@ +source ./env/bin/activate \ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst index d60b003b..2fb0a9bb 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -52,6 +52,7 @@ Bienvenue sur la documentation du Sith de l'AE misc/md_syntax misc/helpers + misc/direnv misc/prod Documentations complémentaires diff --git a/doc/misc/direnv.rst b/doc/misc/direnv.rst new file mode 100644 index 00000000..7801799b --- /dev/null +++ b/doc/misc/direnv.rst @@ -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 `__. + +.. 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. \ No newline at end of file diff --git a/doc/start/install.rst b/doc/start/install.rst index 6f7ff2bc..7ebdf462 100644 --- a/doc/start/install.rst +++ b/doc/start/install.rst @@ -51,6 +51,10 @@ Installer le projet # Prépare la base de donnée ./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 -----------------------------------