1 ## ========================================
2 ## Commands for both workshop and lesson websites.
5 MAKEFILES=Makefile $(wildcard *.mk)
7 PARSER=bin/markdown_ast.rb
11 .PHONY : commands clean files
14 ## commands : show all commands.
16 @grep -h -E '^##' ${MAKEFILES} | sed -e 's/## //g'
18 ## serve : run a local server.
22 ## site : build files but do not run a server.
26 # repo-check : check repository settings.
28 @bin/repo_check.py -s .
30 ## clean : clean up junk files.
34 @rm -rf bin/__pycache__
35 @find . -name .DS_Store -exec rm {} \;
36 @find . -name '*~' -exec rm {} \;
37 @find . -name '*.pyc' -exec rm {} \;
39 ## clean-rmd : clean intermediate R files (that need to be committed to the repo).
44 ## ----------------------------------------
45 ## Commands specific to workshop websites.
47 .PHONY : workshop-check
49 ## workshop-check : check workshop homepage.
51 @bin/workshop_check.py .
53 ## ----------------------------------------
54 ## Commands specific to lesson websites.
56 .PHONY : lesson-check lesson-rmd lesson-files lesson-fixme
59 RMD_SRC = $(wildcard _episodes_rmd/??-*.Rmd)
60 RMD_DST = $(patsubst _episodes_rmd/%.Rmd,_episodes/%.md,$(RMD_SRC))
62 # Lesson source files in the order they appear in the navigation menu.
67 $(wildcard _episodes/*.md) \
69 $(wildcard _extras/*.md) \
72 # Generated lesson files in the order they appear in the navigation menu.
75 ${DST}/conduct/index.html \
76 ${DST}/setup/index.html \
77 $(patsubst _episodes/%.md,${DST}/%/index.html,$(wildcard _episodes/*.md)) \
78 ${DST}/reference/index.html \
79 $(patsubst _extras/%.md,${DST}/%/index.html,$(wildcard _extras/*.md)) \
80 ${DST}/license/index.html
82 ## lesson-rmd : convert Rmarkdown files to markdown
83 lesson-rmd: $(RMD_SRC)
84 @bin/knit_lessons.sh $(RMD_SRC)
86 ## lesson-check : validate lesson Markdown.
88 @bin/lesson_check.py -s . -p ${PARSER}
90 ## lesson-check-all : validate lesson Markdown, checking line lengths and trailing whitespace.
92 @bin/lesson_check.py -s . -p ${PARSER} -l -w
94 ## lesson-figures : re-generate inclusion displaying all figures.
96 @bin/extract_figures.py -p ${PARSER} ${MARKDOWN_SRC} > _includes/all_figures.html
98 ## unittest : run unit tests on checking tools.
100 python bin/test_lesson_check.py
102 ## lesson-files : show expected names of generated files for debugging.
104 @echo 'RMD_SRC:' ${RMD_SRC}
105 @echo 'RMD_DST:' ${RMD_DST}
106 @echo 'MARKDOWN_SRC:' ${MARKDOWN_SRC}
107 @echo 'HTML_DST:' ${HTML_DST}
109 ## lesson-fixme : show FIXME markers embedded in source files.
111 @fgrep -i -n FIXME ${MARKDOWN_SRC} || true
113 #-------------------------------------------------------------------------------
114 # Include extra commands if available.
115 #-------------------------------------------------------------------------------