From 5be8c8d159172f9ff603d70d0b4c507d6cadbc94 Mon Sep 17 00:00:00 2001 From: Roland Geider Date: Wed, 19 Aug 2020 16:04:29 +0200 Subject: [PATCH] Update the documentation to describe usage of sass --- README.rst | 2 +- docs/changelog.rst | 3 ++- docs/development.rst | 2 +- docs/production.rst | 1 + docs/tips_and_tricks.rst | 8 ++++++++ 5 files changed, 13 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 8ae6fe185..8521112ed 100644 --- a/README.rst +++ b/README.rst @@ -44,7 +44,7 @@ and stable state. :: $ sudo apt-get install python3-dev nodejs npm git - $ sudo npm install -g yarn + $ sudo npm install -g yarn sass Then install the python packages from pypi in the virtualenv:: diff --git a/docs/changelog.rst b/docs/changelog.rst index f31d3abfc..de314f52e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -7,8 +7,9 @@ Changelog Upgrade steps from 1.9: * Update python libraries ``pip install -r requirements.txt`` -* Install ``yarn`` (e.g. ``sudo npm install -g yarn``) +* Install ``yarn`` and ``sass`` (e.g. ``sudo npm install -g yarn sass``) * Update CSS and JS libraries ``yarn install`` +* Compile the CSS ``sass wger/core/static/scss/main.scss:wger/core/static/yarn/bootstrap-compiled.css`` * Update static files (only production): ``python manage.py collectstatic`` diff --git a/docs/development.rst b/docs/development.rst index 7a0c80bae..2034a96de 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -28,7 +28,7 @@ Install Requirements :: $ pip install -r requirements_devel.txt - $ npm install yarn + $ npm install -g yarn sass $ python setup.py develop Install application diff --git a/docs/production.rst b/docs/production.rst index 5369292a0..5f27101f6 100644 --- a/docs/production.rst +++ b/docs/production.rst @@ -113,6 +113,7 @@ Get the application:: git clone https://github.com/wger-project/wger.git /home/wger/src cd /home/wger/src pip install -r requirements.txt + npm install -g yarn sass python setup.py develop pip install psycopg2 # Only if using postgres wger create_settings \ diff --git a/docs/tips_and_tricks.rst b/docs/tips_and_tricks.rst index 4a8a472aa..57de0bf83 100644 --- a/docs/tips_and_tricks.rst +++ b/docs/tips_and_tricks.rst @@ -27,6 +27,14 @@ the source and do :: This happens automatically during the bootstrap process. + +Updating SASS files +``````````````````` +After updating the SASS files, you need to compile them to regular CSS:: + + sass wger/core/static/scss/main.scss:wger/core/static/yarn/bootstrap-compiled.css + + Clearing the cache ``````````````````