From 4422619018a3ddac2a7767ad6787f25633cba99a Mon Sep 17 00:00:00 2001 From: Ron Date: Thu, 4 Jan 2024 09:08:41 +0100 Subject: [PATCH] Added docs link to note on Tailwind configuration. (#145) --- .github/workflows/docs.yml | 2 +- docs/getting_started.txt | 9 +++++++++ docs/requirements.txt | 1 + 3 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 4af05d5..c5418fb 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -9,7 +9,7 @@ jobs: docs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: ammaraskar/sphinx-action@master with: docs-folder: "docs/" diff --git a/docs/getting_started.txt b/docs/getting_started.txt index b759fb9..6fb56c5 100644 --- a/docs/getting_started.txt +++ b/docs/getting_started.txt @@ -25,6 +25,15 @@ your project:: CRISPY_TEMPLATE_PACK = "tailwind" +If you use `Tailwind CLI `_, you have to provide the path to your +templates. Since this package contains templates which are within your Pythons `site-packages`, it's hard to tell +Tailwind where these templates live. + +Thanks to Carlton Gibson's blog, you can implement (aka copy & paste) a Django management command and the corresponding +Tailwind configuration: + +https://noumenal.es/notes/tailwind/django-integration/ + Usage ===== diff --git a/docs/requirements.txt b/docs/requirements.txt index 6c5d5d4..b724855 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ sphinx-rtd-theme +docutils<0.21,>=0.18.1