globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

Merge branch 'add_documentation' into 'master'

Browse source 
more documentation to help contributors

See merge request yaal/canaille!50
This commit is contained in:
Éloi Rivard 2022-05-08 14:47:11 +00:00
commit 275f20a5e0
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
CONTRIBUTING.rst
View file

@ -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.