X-Git-Url: https://git.arvados.org/rnaseq-cwl-training.git/blobdiff_plain/0bbff2bb70aef3a6713d2cdbbf18bea3a108b497..ecb16113fc647b59cb3ee4d66bfc717fdb755444:/Makefile diff --git a/Makefile b/Makefile index b5dfe2f..ba5080a 100644 --- a/Makefile +++ b/Makefile @@ -4,9 +4,26 @@ # Settings MAKEFILES=Makefile $(wildcard *.mk) JEKYLL=jekyll +JEKYLL_VERSION=3.8.5 PARSER=bin/markdown_ast.rb DST=_site +# Check Python 3 is installed and determine if it's called via python3 or python +# (https://stackoverflow.com/a/4933395) +ifneq (, $(shell which python3 2>/dev/null)) + PYTHON := python3 +else ifneq (, $(shell which python 2>/dev/null)) + PYTHON_VERSION_FULL := $(wordlist 2,4,$(subst ., ,$(shell python --version 2>&1))) + PYTHON_VERSION_MAJOR := $(word 1,${PYTHON_VERSION_FULL}) + ifneq (3, ${PYTHON_VERSION_MAJOR}) + $(error "Your system does not appear to have Python 3 installed.") + endif + PYTHON := python +else + $(error "Your system does not appear to have any Python installed.") +endif + + # Controls .PHONY : commands clean files .NOTPARALLEL: @@ -14,7 +31,11 @@ all : commands ## commands : show all commands. commands : - @grep -h -E '^##' ${MAKEFILES} | sed -e 's/## //g' + @grep -h -E '^##' ${MAKEFILES} | sed -e "s/## //g" + +## docker-serve : use docker to build the site +docker-serve : + docker run --rm -it -v ${PWD}:/srv/jekyll -p 127.0.0.1:4000:4000 jekyll/jekyll:${JEKYLL_VERSION} make serve ## serve : run a local server. serve : lesson-md @@ -38,7 +59,7 @@ clean : @find . -name '*.pyc' -exec rm {} \; ## clean-rmd : clean intermediate R files (that need to be committed to the repo). -clear-rmd : +clean-rmd : @rm -rf ${RMD_DST} @rm -rf fig/rmd-* @@ -49,7 +70,7 @@ clear-rmd : ## workshop-check : check workshop homepage. workshop-check : - @bin/workshop_check.py . + @${PYTHON} bin/workshop_check.py . ## ---------------------------------------- ## Commands specific to lesson websites. @@ -63,11 +84,11 @@ RMD_DST = $(patsubst _episodes_rmd/%.Rmd,_episodes/%.md,$(RMD_SRC)) # Lesson source files in the order they appear in the navigation menu. MARKDOWN_SRC = \ index.md \ - CONDUCT.md \ + CODE_OF_CONDUCT.md \ setup.md \ - $(wildcard _episodes/*.md) \ + $(sort $(wildcard _episodes/*.md)) \ reference.md \ - $(wildcard _extras/*.md) \ + $(sort $(wildcard _extras/*.md)) \ LICENSE.md # Generated lesson files in the order they appear in the navigation menu. @@ -75,33 +96,28 @@ HTML_DST = \ ${DST}/index.html \ ${DST}/conduct/index.html \ ${DST}/setup/index.html \ - $(patsubst _episodes/%.md,${DST}/%/index.html,$(wildcard _episodes/*.md)) \ + $(patsubst _episodes/%.md,${DST}/%/index.html,$(sort $(wildcard _episodes/*.md))) \ ${DST}/reference/index.html \ - $(patsubst _extras/%.md,${DST}/%/index.html,$(wildcard _extras/*.md)) \ + $(patsubst _extras/%.md,${DST}/%/index.html,$(sort $(wildcard _extras/*.md))) \ ${DST}/license/index.html ## lesson-md : convert Rmarkdown files to markdown lesson-md : ${RMD_DST} -# Use of .NOTPARALLEL makes rule execute only once -${RMD_DST} : ${RMD_SRC} - @bin/knit_lessons.sh ${RMD_SRC} +_episodes/%.md: _episodes_rmd/%.Rmd + @bin/knit_lessons.sh $< $@ ## lesson-check : validate lesson Markdown. -lesson-check : - @bin/lesson_check.py -s . -p ${PARSER} -r _includes/links.md +lesson-check : lesson-fixme + @${PYTHON} bin/lesson_check.py -s . -p ${PARSER} -r _includes/links.md ## lesson-check-all : validate lesson Markdown, checking line lengths and trailing whitespace. lesson-check-all : - @bin/lesson_check.py -s . -p ${PARSER} -l -w - -## lesson-figures : re-generate inclusion displaying all figures. -lesson-figures : - @bin/extract_figures.py -p ${PARSER} ${MARKDOWN_SRC} > _includes/all_figures.html + @${PYTHON} bin/lesson_check.py -s . -p ${PARSER} -r _includes/links.md -l -w --permissive ## unittest : run unit tests on checking tools. unittest : - python bin/test_lesson_check.py + @${PYTHON} bin/test_lesson_check.py ## lesson-files : show expected names of generated files for debugging. lesson-files :