docker: generate the HTML documentation

Relates to https://github.com/shaarli/Shaarli/issues/1153

Signed-off-by: VirtualTam <virtualtam@flibidi.net>

diff --git a/.dockerignore b/.dockerignore
index c92a2a1421cad93075f76d3ffc957b5850df2925..9a18e08581c22e28b4b3e645648f88bc23a19b04 100644 (file)
--- a/.dockerignore
+++ b/.dockerignore
@@ -1,3 +1,7 @@
+# Docker-ignore
+# Note: .git/ is kept for HTML documentation generation
+tests
+
 # Shaarli runtime resources
 cache/*
 data/*

diff --git a/Dockerfile b/Dockerfile
index 5e03814c3656b763160d0796c79cd041e4c52986..e80670315e913b9e48c74116f9fb0947ad8ac701 100644 (file)
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,12 +1,20 @@
 # Stage 1:
 # - Get Shaarli sources
+# - Build documentation
+FROM dalibo/pandocker:stable as docs
+ADD . /pandoc/shaarli
+RUN cd /pandoc/shaarli \
+    && make htmldoc \
+    && rm -rf .git
+
+# Stage 2:
 # - Resolve PHP dependencies with Composer
 FROM composer:latest as composer
-ADD . /app/shaarli
+COPY --from=docs /pandoc/shaarli /app/shaarli
 RUN cd shaarli \
     && composer --prefer-dist --no-dev install
 
-# Stage 2:
+# Stage 3:
 # - Shaarli image
 FROM debian:jessie
 LABEL maintainer="Shaarli Community"

diff --git a/Makefile b/Makefile
index 60aec9a08b6049328ee031dd7e19fbaeafc8664e..47f3530f2048976f1c7701a553c33095e6c13e2a 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -11,6 +11,7 @@
 # - install Xdebug for PHPUnit code coverage reports:
 #   - see http://xdebug.org/docs/install
 #   - enable in php.ini
+SHELL := /bin/bash
 
 BIN = vendor/bin
 PHP_SOURCE = index.php application tests plugins
@@ -203,14 +204,18 @@ htmlsidebar:
 htmlpages:
        @for file in `find doc/ -maxdepth 1 -name "*.md"`; do \
                base=`basename $$file .md`; \
-               sed -i "1i #$${base//-/ }" $$file; \
+               sed -i "1i # $${base//-/ }" $$file; \
                awk 'BEGIN { FS = "[\\[\\]]{2}" }'\
        'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\
        '!m { print $$0 }' $$file > doc/tmp.md; \
                mv doc/tmp.md $$file; \
-               pandoc -f markdown_github -t html5 -s \
+               pandoc  -f gfm \
+                       -t html5 \
+                       -s \
                        -c "github-markdown.css" \
-                       -T Shaarli -M pagetitle:"$${base//-/ }" -B doc/sidebar.html \
+                       -T Shaarli \
+                       -M pagetitle:"$${base//-/ }" \
+                       -B doc/sidebar.html \
                        -o doc/$$base.html $$file; \
        done;