From e97daa9b6544438799b70ec3458c6d6118487c13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Blondon?= Date: Fri, 6 May 2022 17:00:32 +0200 Subject: [PATCH] more documentation to help contributors --- CONTRIBUTING.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1527bc29..b0228be0 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -18,6 +18,7 @@ Development environment .. code-block:: console + python3 setup.py compile_catalog cd demo ./run.sh # or `docker-compose up` to run it with docker @@ -32,3 +33,16 @@ The canaille server has some default users: - A regular user which login and password are **user**; - A moderator user which login and password are **moderator**; - An admin user which admin and password are **admin**. + + +Documentation +------------- + + +The documentation is generated when the tests run: + +.. code-block:: console + + tox + +The generated documentation is in `./build/sphinx/html/` directory.