diff --git a/Makefile b/Makefile index 435fea4..5cff5ae 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,7 @@ docs: mkdir -p site shocco -t 'Python Buildpack Compiler' ./bin/compile > site/index.html + shocco -t 'Django Buildpack Compiler' ./bin/steps/django > site/django.html site: docs cd site && git add -A && git commit -m 'update' && git push heroku master diff --git a/bin/compile b/bin/compile index 852ed04..c8bffbf 100755 --- a/bin/compile +++ b/bin/compile @@ -153,6 +153,9 @@ pip install --use-mirrors -r requirements.txt --src ./.heroku/src | indent # Do additional application hackery if applications appears to be a Django app. # Optionally, disable all Django-specific changes with `DISABLE_INJECTION` env. +# +# See [`bin/steps/django`](django.html). + if [ "$NAME" = "Python/Django" ] && ! [ "$DISABLE_INJECTION" ]; then source $BIN_DIR/steps/django fi diff --git a/bin/steps/django b/bin/steps/django index 47d181d..4ef411a 100755 --- a/bin/steps/django +++ b/bin/steps/django @@ -1,4 +1,14 @@ #!/usr/bin/env bash + +# This script serves as the Django build step of the +# [**Python Buildpack**](https://github.com/heroku/heroku-buildpack-python) +# compiler. +# +# A [buildpack](http://devcenter.heroku.com/articles/buildpacks) is an +# adapter between a Python application and Heroku's runtime. +# +# This script is invoked by [`bin/compile`](/). + echo "-----> Injecting Django settings..." SETTINGS_FILE=$(ls **/settings.py | head -1)