doc: instructions to setup a development environment (#50921)

License: MIT

doc/development.rst

@@ -0,0 +1,52 @@
+.. _development:
+
+===========
+Development
+===========
+
+Get the code and the dependencies
+=================================
+
+1. Clone the repository::
+
+     $ git clone https://git.entrouvert.org/authentic.git
+
+2. Install `lasso <http://lasso.entrouvert.org>`_ python packages::
+
+     $ curl https://deb.entrouvert.org/entrouvert.gpg | sudo apt-key add -
+     $ echo deb http://deb.entrouvert.org/ buster main | \
+            sudo tee /etc/apt/sources.list.d/entrouvert.list
+     $ sudo apt-get update
+     $ sudo apt-get install python-lasso python3-lasso
+
+3. Install dependencies::
+
+     $ sudo apt-get install postgresql build-essential gettext sassc \
+                            libldap2-dev libsasl2-dev python3-dev
+
+Run the tests
+=============
+
+1. Setup a virtualenv::
+
+     $ sudo apt-get install direnv
+     $ echo layout python3 > authentic/.envrc
+     $ direnv allow authentic
+     $ cd authentic
+
+2. Run::
+
+     $ pip install tox
+     $ pg_virtualenv tox
+
+Build the documentation
+=======================
+
+1. Build::
+
+     $ pip install sphinx
+     $ sphinx-build -b html doc build/html
+
+2. Display::
+
+     $ firefox build/html/index.html

doc/index.rst

@@ -36,6 +36,8 @@ please report it on the list.
 
     advanced
 
+    development
+
     copyright
 
 This documentation is under the licence Creative Commons `CC BY-SA 2.0 <http://creativecommons.org/licenses/by-sa/2.0/>`_.