Skip to content

Commit 04b031b

Browse files
committed
docs: note automatic compiles
1 parent fe231e4 commit 04b031b

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

docs/source/install.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -197,28 +197,17 @@ Once you have it installed, update the URL value of `HAYSTACK_CONNECTIONS` setti
197197
Generating CSS files automatically
198198
----------------------------------
199199

200-
Due to performance issues of [django-pipeline](https://github.com/jazzband/django-pipeline/issues/313), we are using
201-
a dummy compiler `pydotorg.compilers.DummySASSCompiler` in development mode.
200+
```{warning}
201+
When editing frontend styles, ensure you ONLY edit the `.scss` files.
202202
203-
To generate CSS files, use `sass` itself in a separate terminal window:
204-
205-
````{note}
206-
To get up an running with SASS,
207-
you need to [install Ruby 2 (>= 2.0.0, < 3.0.0)](https://www.ruby-lang.org/en/documentation/installation/),
208-
the `sussy` gem, and the `sass` gem.
209-
210-
The gems are defined in the `Gemfile` and can be installed by running the following command:
211-
```bash
212-
bundle install
203+
These will then be compiled into `.css` files automatically.
213204
```
214-
````
215205

216-
Then run the following command to generate CSS files:
206+
Static files are automatically compiled inside the [Docker Compose `static` container](../../docker-compose.yml)
207+
when running `make serve`.
217208

218-
```
219-
$ cd static
220-
$ sass --compass --scss -I $(dirname $(dirname $(gem which susy))) --trace --watch sass/style.scss:sass/style.css
221-
```
209+
When your pull request has stylesheet changes, commit the `.scss` files and the compiled `.css` files.
210+
Otherwise, ignore committing and pushing the `.css` files.
222211

223212
Running tests
224213
-------------

0 commit comments

Comments
 (0)