mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-06-07 18:44:08 +00:00
Expanded the installation guide to include required dependencies such as `jq`, `php`, `composer`, and `symfony-cli`, among others. Updated setup commands to include `-W` flag for better dependency handling and added a cache clear step to ensure proper asset compilation. These changes enhance clarity and streamline the installation process.
Chill documentation
Documentation of the Chill software.
The compiled documentation may be read at http://docs.chill.social
Compilation into HTML
To compile this documentation :
- Install sphinx-doc
$ virtualenv .venv # creation of the virtual env (only the first time) $ source .venv/bin/activate # activate the virtual env (.venv) $ pip install -r requirements.txt
- Install submodules : $ git submodule update --init;
- run
make html
from the root directory - The base file is located on build/html/index.html
$ cd build/html $ python -m http.server 8888 # will serve the site on the port 8888
Contribute
Issue tracker : https://gitlab.com/Chill-Projet/chill-bundles/-/issues
Licence
This documentation is available under the GNU Free Documentation Licence.