Makefile

#======================================================================
# Default Makefile for Software Carpentry workshops.  Use 'make' on
# its own to see a list of targets.
#
# To add new lessons, add their Markdown files to the MOST_SRC target.
# Order is important: when we build the single-page book version of
# the notes on the web site, lessons appear in the order in which they
# appear in MOST_SRC.
#
# If the source of those lessons isn't Markdown, whoever adds them is
# responsible for adding rules to convert them from whatever format
# they're in to Markdown.  The section titled "Create Markdown
# versions of IPython Notebooks" does this for IPython Notebooks; if
# more notebooks are added, make sure to add them to the target
# IPYNB_SRC.  If other source formats are used, add a new section to
# this Makefile and list it here.
#
# Note that this Makefile uses $(wildcard pattern) to match sets of
# files instead of using shell wildcards, and $(sort list) to ensure
# that matches are ordered when necessary.
#======================================================================

#----------------------------------------------------------------------
# Settings.
#----------------------------------------------------------------------

# Output directory for local build.
SITE = _site

# Installation directory on server.
INSTALL = $(HOME)/sites/software-carpentry.org/v5

# Jekyll configuration file.
CONFIG = _config.yml

#----------------------------------------------------------------------
# Specify the default target before any other targets are defined so
# that we're sure which one Make will choose.
#----------------------------------------------------------------------

all : commands

#----------------------------------------------------------------------
# Convert Markdown to HTML exactly as GitHub will when files are
# committed in the repository's gh-pages branch.
#----------------------------------------------------------------------

# Source Markdown files.  These are listed in the order in which they
# appear in the final book-format version of the notes.
MOST_SRC = \
	 intro.md \
	 team.md \
	 novice/shell/index.md $(sort $(wildcard novice/shell/??-*.md)) \
	 novice/git/index.md $(sort $(wildcard novice/git/??-*.md)) \
	 novice/hg/index.md $(sort $(wildcard novice/hg/??-*.md)) \
	 novice/python/index.md $(sort $(wildcard novice/python/??-*.md)) \
	 novice/matlab/index.md $(sort $(wildcard novice/matlab/??-*.md)) \
	 novice/sql/index.md $(sort $(wildcard novice/sql/??-*.md)) \
	 novice/extras/index.md $(sort $(wildcard novice/extras/??-*.md)) \
	 novice/teaching/index.md  $(sort $(wildcard novice/teaching/??-*.md)) \
	 teaching/index.md $(sort $(wildcard teaching/??-*.md)) \
	 novice/ref/index.md  $(sort $(wildcard novice/ref/??-*.md)) \
	 bib.md \
	 gloss.md \
	 rules.md \
	 LICENSE.md

# All source pages (including things not in the book).
ALL_SRC = \
	contents.md \
	setup.md \
        $(wildcard intermediate/regex/*.md) \
	$(wildcard intermediate/python/*.md) \
	$(wildcard intermediate/doit/*.md) \
	$(wildcard intermediate/webdata/*.md) \
	$(wildcard slides/*.html) \
	$(MOST_SRC)

# Other files that the site depends on.
EXTRAS = \
       $(wildcard css/*.css) \
       $(wildcard css/*/*.css) \
       $(wildcard _layouts/*.html)

# Principal target files
INDEX = $(SITE)/index.html

# All in one HTML target
BOOK_HTML = $(SITE)/book.html

# Convert from Markdown to HTML.  This builds *all* the pages (Jekyll
# only does batch mode), and erases the SITE directory first, so
# having the output index.html file depend on all the page source
# Markdown files triggers the desired build once and only once.
$(INDEX) : ./index.html $(ALL_SRC) $(CONFIG) $(EXTRAS)
	 jekyll build -t -d $(SITE)

#----------------------------------------------------------------------
# Create all-in-one book version of notes.
#----------------------------------------------------------------------

# Temporary book file.
BOOK_MD = ./book.md

# Build the temporary input for the book by concatenating relevant
# sections of Markdown files and then patching glossary references and
# image paths.
#
# Need to fix anchors to glossary references since it now will be in the same
# file as the lessons.
$(BOOK_MD) : $(MOST_SRC) bin/make-book.py
	python bin/make-book.py $(MOST_SRC) > $@
	sed -i.bak 's/\.\.\/\.\.\/gloss.html#/#g:/g' $@
	rm book.md.bak

$(BOOK_HTML): $(BOOK_MD)
	make -B site

#----------------------------------------------------------------------
# Targets.
#----------------------------------------------------------------------

## ---------------------------------------

## commands : show all commands.
commands :
	@grep -E '^##' Makefile | sed -e 's/##//g'

## ---------------------------------------

## site     : build the site as GitHub will see it.
site : $(INDEX)

## check    : check that the index.html file is properly formatted.
check :
	@python bin/swc_index_validator.py ./index.html

## clean    : clean up all generated files.
clean : tidy
	rm -rf $(SITE)

## ---------------------------------------

## book     : build the site including the all-in-one book.
#  To do this, we simply create the book Markdown file then build
#  with Jekyll as usual.
book : $(BOOK_HTML)

## epub     : build epub version of lessons (this is experimental)
epub : book
	make -f epub.mk epub

## install  : install on the server.
install : $(INDEX)
	rm -rf $(INSTALL)
	mkdir -p $(INSTALL)
	cp -r $(SITE)/* $(INSTALL)
	mv $(INSTALL)/contents.html $(INSTALL)/index.html

## contribs : list contributors.
#  Relies on ./.mailmap to translate user IDs into names.
contribs :
	git log --pretty=format:%aN | sort | uniq

## fixme    : find places where fixes are needed.
fixme :
	grep -i -n FIXME $$(find novice -type f -print | grep -v .ipynb_checkpoints)

## gloss    : check the glossary.
gloss : $(INDEX)
	python bin/gloss.py gloss.md $(patsubst %.md,$(SITE)/%.html,$(MOST_SRC))

## tidy     : clean up odds and ends.
tidy :
	rm -rf \
	$$(find . -name '*~' -print) \
	$$(find . -name '*.pyc' -print) \
	$(BOOK_MD)

#----------------------------------------------------------------------
# Rules to launch builds of formats other than Markdown.
#----------------------------------------------------------------------

## ---------------------------------------

## ipynb    : convert IPython Notebooks to Markdown files.
#  This uses an auxiliary Makefile 'ipynb.mk'.
ipynb :
	make -f ipynb.mk

## rmd      : convert R Markdown files to Markdown.
#  This uses an auxiliary Makefile 'rmd.mk'.
rmd :
	make -f rmd.mk

## ---------------------------------------


.PHONY: all book check clean commands contribs epub fixme gloss install ipynb site tidy rmd