v2.1.0 Release (May 29, 2019)

ALL-for-build/Makedir/conf.py

@@ -32,8 +32,11 @@
 lexers['php'] = PhpLexer(startinline=True)
 lexers['php-annotations'] = PhpLexer(startinline=True)
 
+# CommonMarkParser turns Sphinx caching off
+# Let's not use it. Instead preprocess with 'pandoc'
 try:
-    from recommonmark.parser import CommonMarkParser
+    # from recommonmark.parser import CommonMarkParser
+    CommonMarkParser = None
 except ImportError:
     CommonMarkParser = None
 

ALL-for-build/Menu/mainmenu.sh

@@ -87,24 +87,18 @@ Final exit status: $exitstatus (aborted)
 Check for results:
 EOT
 fi
-if [ -f /RESULT/Result/project/0.0.0/Index.html ];then
-   echo "   ./Documentation-GENERATED-temp/Result/project/0.0.0/Index.html"
-fi
-if [ -f /RESULT/Result/project/0.0.0/index.html ];then
-   echo "   ./Documentation-GENERATED-temp/Result/project/0.0.0/index.html"
-fi
-if [ -f /RESULT/Result/project/0.0.0/singlehtml ];then
-   echo "   ./Documentation-GENERATED-temp/Result/project/0.0.0/singlehtml/"
-fi
-if [ -d /RESULT/Result/project/0.0.0/_buildinfo ];then
-   echo "   ./Documentation-GENERATED-temp/Result/project/0.0.0/_buildinfo/"
-fi
-if [ -f /RESULT/Result/project/0.0.0/_buildinfo/warnings.txt ];then
+echo >/RESULT/warning-files.txt
+find /RESULT/Result -type f -regextype posix-egrep -iregex '.*/0\.0\.0/Index\.html$' -printf "  ./Documentation-GENERATED-temp/Result/%P\\n"
+find /RESULT/Result -type d -regextype posix-egrep -regex  '.*/0\.0\.0/singlehtml$'  -printf "  ./Documentation-GENERATED-temp/Result/%P\\n"
+find /RESULT/Result -type d -regextype posix-egrep -regex  '.*/0\.0\.0/_buildinfo$'  -printf "  ./Documentation-GENERATED-temp/Result/%P\\n"
+find /RESULT/Result -type f -regextype posix-egrep -regex  '.*/_buildinfo/warnings\.txt$' \! -empty -printf "  ./Documentation-GENERATED-temp/Result/%P\\n"
+find /RESULT/Result -type f -regextype posix-egrep -regex  '.*/_buildinfo/warnings\.txt$' \! -empty -printf "  ./Documentation-GENERATED-temp/Result/%P\\n" >>/RESULT/warning-files.txt
+
+if [ -f /RESULT/warning-files.txt ];then
    echo
-   if [ -s /RESULT/Result/project/0.0.0/_buildinfo/warnings.txt ];then
-      echo "\nATTENTION:"
-      echo "   There are Sphinx warnings in"
-      echo "   ./Documentation-GENERATED-temp/Result/project/0.0.0/_buildinfo/warnings.txt"
+   if [ -s /RESULT/warning-files.txt ];then
+      echo "ATTENTION:"
+      echo "   There are Sphinx warnings!"
     else
       echo "Congratulations:"
       echo "    There are no Sphinx warnings!"
@@ -122,7 +116,7 @@ if [[ -f /tmp/RenderDocumentation/Todo/ALL.source-me.sh ]]
 then
    rm -f /tmp/RenderDocumentation/Todo/ALL.source-me.sh
 fi
-cmd="tct --cfg-file=/ALL/Rundir/tctconfig.cfg -v"
+cmd="tct --cfg-file=/ALL/venv/tctconfig.cfg -v"
 cmd="$cmd run RenderDocumentation -c makedir /ALL/Makedir"
 cmd="$cmd -c make_latex 1 -c make_package 1 -c make_pdf 1 -c make_singlehtml 1"
 cmd="$cmd $@"
@@ -156,7 +150,7 @@ if [[ -f /tmp/RenderDocumentation/Todo/ALL.source-me.sh ]]
 then
    rm -f /tmp/RenderDocumentation/Todo/ALL.source-me.sh
 fi
-cmd="tct --cfg-file=/ALL/Rundir/tctconfig.cfg -v"
+cmd="tct --cfg-file=/ALL/venv/tctconfig.cfg -v"
 cmd="$cmd run RenderDocumentation -c makedir /ALL/Makedir"
 cmd="$cmd -c make_latex 0 -c make_package 0 -c make_pdf 0 -c make_singlehtml 0"
 cmd="$cmd $@"

ALL-for-build/Menu/show-shell-commands.sh

@@ -29,18 +29,18 @@ function ${DOCKRUN_PREFIX}${OUR_IMAGE_SHORT} () {
 # no slash ('/') at the end,
 # default is the current directory \$(pwd):
 #
-#     T3DOCS_PROJECT=/absolute/path/to/project/start/folder
-#     T3DOCS_RESULT=/absolute/path/to/result/folder
-#     T3DOCS_TMP=/absolute/path/to/temporary/folder
-#     T3DOCS_DUMMY_WEBROOT=/absolute/path/to/output/dummy_webroot/
+#     T3DOCS_PROJECT=/abspathto/MyProjectStartFolder       (readonly)
+#     T3DOCS_RESULT=/abspathto/ResultFolder                (readwrite)
+#     T3DOCS_TMP=/abspathto/TemporaryFolder                (readwrite)
+#     T3DOCS_DUMMY_WEBROOT=/abspathto/dummy_webroot_folder (readwrite)
 #
 # Environment variables only some DEVELOPERS may find important,
 # no slash ('/') at the end,
 #
-#     T3DOCS_MAKEDIR=/absolute/path/to/makedir
-#     T3DOCS_MENU=/absolute/path/to/menu
-#     T3DOCS_RUNDIR=/absolute/path/to/rundir
-#     T3DOCS_TOOLCHAINS=/absolute/path/to/toolchains
+#     T3DOCS_MAKEDIR=/abspathto/MYALL/Makedir
+#     T3DOCS_MENU=/abspathto/MYALL/Menu
+#     T3DOCS_VENV=/abspathto/MYALL/venv
+#     T3DOCS_TOOLCHAINS=/abspathto/MYALL/Toolchains
 
 # Example:
 # local DEBUG=\${T3DOCS_DEBUG:-0}
@@ -125,12 +125,12 @@ if [ -d "\$MENU" ]; then
    if ((\$DEBUG)); then echo "MENU.........: \$MENU"; fi
 fi
 
-# RUNDIR
-# absolute path to existing folder RUNDIR
-local RUNDIR=\${T3DOCS_RUNDIR:-\$(pwd)/tmp-GENERATED-Rundir}
-if [ -d "\$RUNDIR" ]; then
-   cmd="\$cmd -v \$RUNDIR:/ALL/Rundir"
-   if ((\$DEBUG)); then echo "RUNDIR.......: \$RUNDIR"; fi
+# VENV (used to be 'Rundir')
+# absolute path to existing folder VENV
+local VENV=\${T3DOCS_VENV:-\$(pwd)/tmp-GENERATED-venv}
+if [ -d "\$VENV" ]; then
+   cmd="\$cmd -v \$VENV:/ALL/venv"
+   if ((\$DEBUG)); then echo "VENV.........: \$VENV"; fi
 fi
 
 # TOOLCHAINS

ALL-for-build/venv/Pipfile

@@ -14,16 +14,16 @@ pathlib2 = "*"
 pytest = "*"
 recommonmark = "*"
 
-sphinxcontrib-googlechart = {file = "https://github.com/TYPO3-Documentation/sphinx-contrib-googlechart/archive/develop.zip"}
-sphinxcontrib-googlemaps = {file = "https://github.com/TYPO3-Documentation/sphinx-contrib-googlemaps/archive/develop.zip"}
+sphinxcontrib-googlechart = {file = "https://github.com/TYPO3-Documentation/sphinx-contrib-googlechart/archive/t3v0.2.1.zip"}
+sphinxcontrib-googlemaps = {file = "https://github.com/TYPO3-Documentation/sphinx-contrib-googlemaps/archive/t3v0.1.1.zip"}
 sphinxcontrib-phpdomain = "*"
-sphinxcontrib-slide = {file = "https://github.com/TYPO3-Documentation/sphinx-contrib-slide/archive/develop.zip"}
-sphinxcontrib-t3fieldlisttable = {file = "https://github.com/TYPO3-Documentation/sphinxcontrib.t3fieldlisttable/archive/develop.zip"}
-sphinxcontrib-t3tablerows = {file = "https://github.com/TYPO3-Documentation/sphinxcontrib.t3tablerows/archive/develop.zip"}
-sphinxcontrib-t3targets = {file = "https://github.com/TYPO3-Documentation/sphinxcontrib.t3targets/archive/develop.zip"}
-sphinxcontrib-youtube = {file = "https://github.com/TYPO3-Documentation/sphinx-contrib-youtube/archive/master.zip"}
-t3SphinxThemeRtd = {file = "https://github.com/TYPO3-Documentation/t3SphinxThemeRtd/archive/develop.zip"}
-tct = {file = "https://github.com/marble/TCT/archive/develop.zip"}
+sphinxcontrib-slide = {file = "https://github.com/TYPO3-Documentation/sphinx-contrib-slide/archive/t3v0.3.1.zip"}
+sphinxcontrib-t3fieldlisttable = {file = "https://github.com/TYPO3-Documentation/sphinxcontrib.t3fieldlisttable/archive/v0.3.0.zip"}
+sphinxcontrib-t3tablerows = {file = "https://github.com/TYPO3-Documentation/sphinxcontrib.t3tablerows/archive/v0.2.0.zip"}
+sphinxcontrib-t3targets = {file = "https://github.com/TYPO3-Documentation/sphinxcontrib.t3targets/archive/v0.2.1.zip"}
+sphinxcontrib-youtube = {file = "https://github.com/TYPO3-Documentation/sphinx-contrib-youtube/archive/t3v1.0.zip"}
+t3SphinxThemeRtd = {file = "https://github.com/TYPO3-Documentation/t3SphinxThemeRtd/archive/v3.6.16.zip"}
+tct = {file = "https://github.com/marble/TCT/archive/v0.3.0.zip"}
 
 [requires]
 python_version = "2.7"

ALL-for-build/venv/info.txt

@@ -0,0 +1,13 @@
+info.txt about /ALL/venv
+
+
+1. At image build time a Python virtual environment is created here from the
+   Pipfile.
+
+2. When running the container /ALL/venv is the WORKDIR = current dir.
+
+3. It is expected that the TCT config file can be found here as
+   /ALL/venv/tctconfig.cfg
+
+End of info.txt
+

CHANGES.rst

@@ -1,16 +1,89 @@
-Release v2.0.0 (released May 25, 2019
-=====================================
+Release v2.1.0 (released May 29, 2019)
+======================================
+
+Enhancements
+------------
+
+*  `#11: <https://github.com/t3docs/docker-render-documentation/issues/11>`__
+   Again: Improve the output of "Find the results:"
+
+*  `#50 <https://github.com/t3docs/docker-render-documentation/issues/50>`__
+   Now installing specific versions from Pipfile
+
+
+Bugs fixed
+----------
+
+*  `#51: <https://github.com/t3docs/docker-render-documentation/issues/51>`__
+   Sphinx caching is working again. Removed recommonmark parser.
+
+*  `#54: <https://github.com/t3docs/docker-render-documentation/issues/54>`__
+   Have markdown files converted to rst by pandoc.
+
+*  `#58: <https://github.com/t3docs/docker-render-documentation/issues/58>`__
+   Catch YAML parser errors the better way.
+
+
+Significant internal changes
+----------------------------
+
+*  `#55: <https://github.com/t3docs/docker-render-documentation/issues/55>`__
+   Use /ALL/venv as workdir, remove folder /ALL/Rundir
+
+
+
+Release v2.0.0 (released May 25, 2019)
+======================================
+
+This is a complete revamp of v1.6 of branch '1-6'.
+
 
-Description
------------
+Characteristics
+---------------
+
+*  codename 'dockrun_t3rd'
+*  based on image ubuntu:18.04
+*  almost migrated to Python 3
+*  using pipenv as Python packet manager
+*  only for html and singlehtml
+*  much smaller in size
+
+
+Enhancements
+------------
+
+*  `#11 <https://github.com/t3docs/docker-render-documentation/issues/11>`__
+   Improve the output of "Find the results:"
+
+*  `#53 <https://github.com/t3docs/docker-render-documentation/issues/53>`__
+   Load `these sphinx extensions
+   <https://github.com/t3docs/docker-render-documentation/blob/8fc0989c0e61cfd55b060b7fbefd138c910d87a3/ALL-for-build/Makedir/conf.py#L165>`__
+   by default
+
+
+
+Features added
+--------------
+
+*  `#20 <https://github.com/t3docs/docker-render-documentation/issues/20>`__
+   Add sphinxcontrib.phpdomain
+
+
+Bugs fixed
+----------
+
+*  `#03: <https://github.com/t3docs/docker-render-documentation/issues/3>`__
+   Fix sphinxcontrib.googlemaps
+
+*  `#18: <https://github.com/t3docs/docker-render-documentation/issues/18>`__
+   Fix sphinxcontrib.googlemaps
+
+*  `#31: <https://github.com/t3docs/docker-render-documentation/issues/31>`__
+   Fix rendering of standalone README.(rst|md)
+
+*  `#52: <https://github.com/t3docs/docker-render-documentation/issues/52>`__
+   Fix sphinxcontrib.googlechart
 
-* codename 'dockrun_t3rd'
-* complete revamp of branch '1-6'
-* based on Ubuntu:18.04
-* almost migrated to Python3
-* using pipenv as Python packet manager
-* only for html and singlehtml
-* smaller in size (< 850 MB)
 
 
 Previous v1.6 releases (forked May 25, 2019)
@@ -77,7 +150,14 @@ Some recommended headlines:
 | Deprecated
 | Features added
 | Features removed
+| Enhancements
 | Incompatible changes
+| Significant internal changes
+
+Maximum characters per line: 79 (except longlinks)
+
+         1         2         3         4         5         6         7
 
+1234567890123456789012345678901234567890123456789012345678901234567890123456789
 
-End of CHANGES.
+End of CHANGES.

Dockerfile

@@ -1,6 +1,6 @@
 FROM ubuntu:18.04
 
-ARG OUR_IMAGE_VERSION=v2.0.0
+ARG OUR_IMAGE_VERSION=v2.1.0
 ARG OUR_IMAGE_TAG=${OUR_IMAGE_VERSION}
 # flag for apt-get - affects only build time
 ARG DEBIAN_FRONTEND=noninteractive
@@ -13,14 +13,14 @@ ENV \
    LC_ALL=C.UTF-8 \
    LANG=C.UTF-8 \
    HOME="/ALL/userhome" \
-   TOOLCHAIN_VERSION="develop" \
-   TOOLCHAIN_UNPACKED="Toolchain_RenderDocumentation-develop" \
-   TOOLCHAIN_URL="https://github.com/marble/Toolchain_RenderDocumentation/archive/develop.zip" \
+   TOOLCHAIN_VERSION="2.4.0" \
+   TOOLCHAIN_UNPACKED="Toolchain_RenderDocumentation-2.4.0" \
+   TOOLCHAIN_URL="https://github.com/marble/Toolchain_RenderDocumentation/archive/v2.4.0.zip" \
    TYPOSCRIPT_PY_VERSION="v2.2.4" \
    TYPOSCRIPT_PY_URL="https://raw.githubusercontent.com/TYPO3-Documentation/Pygments-TypoScript-Lexer/v2.2.4/typoscript.py" \
    OUR_IMAGE="$hack_OUR_IMAGE" \
    OUR_IMAGE_SHORT="$hack_OUR_IMAGE_SHORT" \
-   THEME_VERSION="develop" \
+   THEME_VERSION="3.6.16" \
    THEME_MTIME="1530870718"
 
 LABEL \
@@ -80,7 +80,7 @@ RUN \
    && apt-get remove python-pip -y \
    && /usr/local/bin/pip install --upgrade pipenv \
    \
-   && COMMENT "Disable /ALL/venv/Pipfile.lock - it didn't work" \
+   && COMMENT "Disable /ALL/venv/Pipfile.lock - it didn't work reliably" \
    && if [ -f "Pipfile.lock" ]; then mv Pipfile.lock Pipfile.lock.DISABLED; fi \
    \
    && COMMENT "Install from /ALL/venv/Pipfile" \
@@ -99,7 +99,8 @@ RUN \
            --quiet --output-document /usr/local/bin/t3xutils.phar \
    && chmod +x /usr/local/bin/t3xutils.phar \
    \
-   && COMMENT "All files of the theme shall have an informative modification time" \
+   && COMMENT "All files of the theme of a given theme version should have the" \
+   && COMMENT "same mtime (last commit) to not turn off Sphinx caching" \
    && python=$(pipenv --venv)/bin/python \
    && destdir=$(dirname $($python -c "import t3SphinxThemeRtd; print t3SphinxThemeRtd.__file__")) \
    && find $destdir -exec touch --no-create --time=mtime --date="$(date --rfc-2822 --date=@$THEME_MTIME)" {} \; \
@@ -135,8 +136,6 @@ RUN \
    && echo "export OUR_IMAGE_SHORT=\"${OUR_IMAGE_SHORT}\""         >> /ALL/Downloads/envvars.sh \
    && echo "export OUR_IMAGE_SLOGAN=\"${OUR_IMAGE_SLOGAN}\""       >> /ALL/Downloads/envvars.sh \
    && echo "export OUR_IMAGE_VERSION=\"${OUR_IMAGE_VERSION}\""     >> /ALL/Downloads/envvars.sh \
-   && echo "export SPHINX_CONTRIB_HASH=\"${SPHINX_CONTRIB_HASH}\"" >> /ALL/Downloads/envvars.sh \
-   && echo "export TCT_PIPINSTALL_URL=\"${TCT_PIPINSTALL_URL}\""   >> /ALL/Downloads/envvars.sh \
    && echo "export TOOLCHAIN_URL=\"${TOOLCHAIN_URL}\""             >> /ALL/Downloads/envvars.sh \
    \
    && COMMENT "Let's have some debug info" \
@@ -147,19 +146,16 @@ RUN \
       debug_info OUR_IMAGE_SHORT....: ${OUR_IMAGE_SHORT}\n\
       debug_info OUR_IMAGE_SLOGAN...: ${OUR_IMAGE_SLOGAN}\n\
       debug_info OUR_IMAGE_VERSION..: ${OUR_IMAGE_VERSION}\n\
-      debug_info TCT_PIPINSTALL_URL.: ${TCT_PIPINSTALL_URL}\n\
       debug_info TOOLCHAIN_URL......: ${TOOLCHAIN_URL}\n\
       \n\
       Versions used for $OUR_IMAGE_VERSION:\n\
-      ((below - to be fixed))\n\
-      ((Sphinx theme        t3SphinxThemeRtd       $THEME_VERSION  mtime:$THEME_MTIME))\n\
-      ((Toolchain           RenderDocumentation    $TOOLCHAIN_VERSION))\n\
-      ((Toolchain tool      TCT                    0.2.0))\n\
-      ((TYPO3-Documentation typo3.latex            v1.1.0))\n\
-      ((TypoScript lexer    typoscript.py          $TYPOSCRIPT_PY_VERSION))\n" | cut -b 7- > /ALL/Downloads/buildinfo.txt \
+      Sphinx theme        t3SphinxThemeRtd       $THEME_VERSION  mtime:$THEME_MTIME\n\
+      Toolchain           RenderDocumentation    $TOOLCHAIN_VERSION\n\
+      Toolchain tool      TCT                    0.3.0\n\
+      TYPO3-Documentation typo3.latex            v1.1.0\n\
+      TypoScript lexer    typoscript.py          $TYPOSCRIPT_PY_VERSION))\n" | cut -b 7- > /ALL/Downloads/buildinfo.txt \
    && cat /ALL/Downloads/buildinfo.txt
 
-WORKDIR /ALL/Rundir
 
 ENTRYPOINT ["/ALL/Menu/mainmenu.sh"]
 

Dockerfile.build.sh

@@ -11,7 +11,7 @@ function usage() {
    echo
    echo "Examples:"
    echo "   ./$(basename -- $0) --help"
-   echo "   OUR_IMAGE_TAG=v7.8.9 ./$(basename -- $0)"
+   echo "   OUR_IMAGE_TAG=v77.88.99 ./$(basename -- $0)"
    echo
 }
 

README.rst

@@ -6,9 +6,9 @@ How to build the TYPO3 official Docker image `t3docs/render-documentation` for
 rendering TYPO3 documentation.
 
 :Repository:      https://github.com/t3docs/docker-render-documentation
-:Version:         v2.0.0
+:Version:         v2.1.0
 :Capabilites:     html, singlehtml
-:Docker image:    t3docs/render-documentation:v2.0.0,
+:Docker image:    t3docs/render-documentation:v2.1.0,
                   https://hub.docker.com/r/t3docs/render-documentation/
 :Docker tags:     https://hub.docker.com/r/t3docs/render-documentation/tags/
 :Documented at:   https://github.com/t3docs/t3docs-documentation
@@ -37,15 +37,15 @@ All systems
 
 Pull and run the image to show some help::
 
-   docker run --rm t3docs/render-documentation:v2.0.0
+   docker run --rm t3docs/render-documentation:v2.1.0
 
 
 Linux-like systems
 ------------------
 
 Define convenience function (=shell command) `dockrun_t3rd`::
 
-   source <(docker run --rm t3docs/render-documentation:v2.0.0 show-shell-commands)
+   source <(docker run --rm t3docs/render-documentation:v2.1.0 show-shell-commands)
 
 Create a project and render the documentation::
 

VERSION.txt

@@ -1,5 +1,5 @@
 
-v2.0.0
+v2.1.0
 
 
 Keep version number like above in files: