Switching to GitHub-defined variables
[rnaseq-cwl-training.git] / Makefile
index 75080346d684323818b7f4c5480dd0b1785d32ee..0f395a310aeb0d795abed5ef50a77ee745337236 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -11,23 +11,23 @@ DST=_site
 .PHONY : commands clean files
 all : commands
 
-## commands       : show all commands.
+## commands         : show all commands.
 commands :
        @grep -h -E '^##' ${MAKEFILES} | sed -e 's/## //g'
 
-## serve          : run a local server.
+## serve            : run a local server.
 serve : lesson-rmd
-       ${JEKYLL} serve --config _config.yml,_config_dev.yml
+       ${JEKYLL} serve
 
-## site           : build files but do not run a server.
+## site             : build files but do not run a server.
 site : lesson-rmd
-       ${JEKYLL} build --config _config.yml,_config_dev.yml
+       ${JEKYLL} build
 
-## figures        : re-generate inclusion displaying all figures.
-figures :
-       @bin/extract_figures.py -s _episodes -p ${PARSER} > _includes/all_figures.html
+# repo-check        : check repository settings.
+repo-check :
+       @bin/repo_check.py -s .
 
-## clean          : clean up junk files.
+## clean            : clean up junk files.
 clean :
        @rm -rf ${DST}
        @rm -rf .sass-cache
@@ -35,29 +35,32 @@ clean :
        @find . -name .DS_Store -exec rm {} \;
        @find . -name '*~' -exec rm {} \;
        @find . -name '*.pyc' -exec rm {} \;
+
+## clean-rmd        : clean intermediate R files (that need to be committed to the repo).
+clear-rmd :
        @rm -rf ${RMD_DST}
-       @rm -rf fig/swc-rmd-*
+       @rm -rf fig/rmd-*
 
 ## ----------------------------------------
 ## Commands specific to workshop websites.
 
 .PHONY : workshop-check
 
-## workshop-check : check workshop homepage.
+## workshop-check   : check workshop homepage.
 workshop-check :
        @bin/workshop_check.py .
 
 ## ----------------------------------------
 ## Commands specific to lesson websites.
 
-.PHONY : lesson-check lesson-rmd lesson-files lesson-fixme lesson-single
+.PHONY : lesson-check lesson-rmd lesson-files lesson-fixme
 
 # RMarkdown files
 RMD_SRC = $(wildcard _episodes_rmd/??-*.Rmd)
 RMD_DST = $(patsubst _episodes_rmd/%.Rmd,_episodes/%.md,$(RMD_SRC))
 
 # Lesson source files in the order they appear in the navigation menu.
-SRC_FILES = \
+MARKDOWN_SRC = \
   index.md \
   CONDUCT.md \
   setup.md \
@@ -67,7 +70,7 @@ SRC_FILES = \
   LICENSE.md
 
 # Generated lesson files in the order they appear in the navigation menu.
-HTML_FILES = \
+HTML_DST = \
   ${DST}/index.html \
   ${DST}/conduct/index.html \
   ${DST}/setup/index.html \
@@ -76,26 +79,36 @@ HTML_FILES = \
   $(patsubst _extras/%.md,${DST}/%/index.html,$(wildcard _extras/*.md)) \
   ${DST}/license/index.html
 
-## lesson-rmd:    : convert Rmarkdown files to markdown
+## lesson-rmd       : convert Rmarkdown files to markdown
 lesson-rmd: $(RMD_SRC)
-       @bin/knit_lessons.sh
+       @bin/knit_lessons.sh $(RMD_SRC)
 
-## lesson-check   : validate lesson Markdown.
+## lesson-check     : validate lesson Markdown.
 lesson-check :
        @bin/lesson_check.py -s . -p ${PARSER}
 
+## 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
+
+## unittest         : run unit tests on checking tools.
 unittest :
        python bin/test_lesson_check.py
 
-## lesson-files   : show expected names of generated files for debugging.
+## lesson-files     : show expected names of generated files for debugging.
 lesson-files :
-       @echo 'RMarkdown:' ${RMD_SRC}
-       @echo 'source:' ${SRC_FILES}
-       @echo 'generated:' ${HTML_FILES}
+       @echo 'RMD_SRC:' ${RMD_SRC}
+       @echo 'RMD_DST:' ${RMD_DST}
+       @echo 'MARKDOWN_SRC:' ${MARKDOWN_SRC}
+       @echo 'HTML_DST:' ${HTML_DST}
 
-## lesson-fixme   : show FIXME markers embedded in source files.
+## lesson-fixme     : show FIXME markers embedded in source files.
 lesson-fixme :
-       @fgrep -i -n FIXME ${SRC_FILES} || true
+       @fgrep -i -n FIXME ${MARKDOWN_SRC} || true
 
 #-------------------------------------------------------------------------------
 # Include extra commands if available.