Ongong work

Dockerfile

 # A image for building paddle binaries
 # Use cuda devel base image for both cpu and gpu environment
-FROM nvidia/cuda:8.0-cudnn5-devel-ubuntu14.04
+FROM nvidia/cuda:8.0-cudnn5-devel-ubuntu16.04
 MAINTAINER PaddlePaddle Authors <paddle-dev@baidu.com>
 
 ARG UBUNTU_MIRROR
@@ -23,11 +23,13 @@ ENV HOME /root
 COPY ./paddle/scripts/docker/root/ /root/
 
 RUN apt-get update && \
-    apt-get install -y git python-pip python-dev openssh-server bison && \
-    apt-get install -y wget unzip tar xz-utils bzip2 gzip coreutils && \
-    apt-get install -y curl sed grep graphviz libjpeg-dev zlib1g-dev && \
-    apt-get install -y python-numpy python-matplotlib gcc g++ gfortran && \
-    apt-get install -y automake locales clang-format-3.8 swig doxygen && \
+    apt-get install -y \
+    git python-pip python-dev openssh-server bison  \
+    wget unzip tar xz-utils bzip2 gzip coreutils  \
+    curl sed grep graphviz libjpeg-dev zlib1g-dev  \
+    python-numpy python-matplotlib gcc g++ gfortran  \
+    automake locales clang-format-3.8 swig doxygen cmake  \
+    clang-3.8 llvm-3.8 libclang-3.8-dev && \
     apt-get clean -y
 
 # git credential to skip password typing
@@ -51,11 +53,12 @@ RUN pip install --upgrade pip && \
 RUN apt-get install -y libssl-dev libffi-dev
 RUN pip install certifi urllib3[secure]
 
-RUN curl -sSL https://cmake.org/files/v3.4/cmake-3.4.1.tar.gz | tar -xz && \
-    cd cmake-3.4.1 && ./bootstrap && make -j `nproc` && make install && \
-    cd .. && rm -rf cmake-3.4.1
-
-VOLUME ["/woboq_out"]
+# Install woboq_codebrowser to /woboq
+RUN git clone https://github.com/woboq/woboq_codebrowser /woboq && \
+    (cd /woboq \
+     cmake -DLLVM_CONFIG_EXECUTABLE=/usr/bin/llvm-config-3.8 \
+           -DCMAKE_BUILD_TYPE=Release . \
+     make)
 
 # Configure OpenSSH server. c.f. https://docs.docker.com/engine/examples/running_ssh_service
 RUN mkdir /var/run/sshd

doc/howto/dev/write_docs_cn.rst

@@ -2,14 +2,13 @@
 如何贡献/修改文档
 ##################
 
-PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成，生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。
+PaddlePaddle的文档文件都在 :code:`doc` 这个子目录里。源文件是 `RST <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ 格式的。 在编译PaddlePaddle源码的时候，可以选择让 `cmake<https://cmake.org/>`_ 调用 `sphinx <http://www.sphinx-doc.org/en/1.4.8/>`_ 从 RST 文件生成 HTML 格式的文档。
 
 
 如何构建PaddlePaddle的文档
 ==========================
 
-PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式，我们提供了一个构建脚本build_docs.sh来进行构建。
-PaddlePaddle文档需要准备的环境相对较复杂，所以我们推荐使用基于Docker来构建PaddlePaddle的文档。
+为了简化大家安装文档构建工具的过程，我们提供一个Docker image。
 
 
 使用Docker构建PaddlePaddle的文档
@@ -74,5 +73,5 @@ PaddlePaddle文档使用 `sphinx`_ 自动生成，用户可以参考sphinx教程
 
 
 
-..  _cmake: https://cmake.org/
-..  _sphinx: http://www.sphinx-doc.org/en/1.4.8/
+..  _cmake:
+..  _sphinx:

doc/howto/dev/write_docs_en.rst

+###############
+Build Documents
+###############
+
+Document files of PaddlePaddle are in sub-directory :code:`doc`.  Source files are in `RST <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ format.  We can build the document by letting `cmake<https://cmake.org/>`_ invoke `sphinx <http://www.sphinx-doc.org/en/1.4.8/>`_  to convert RST files into HTML files.
+
+
+How to Build Documents
+======================
+
+To save the time of installing building tools, we provide a Docker image.
+
+
+使用Docker构建PaddlePaddle的文档
+--------------------------------
+
+使用Docker构建PaddlePaddle的文档，需要在系统里先安装好Docker工具包。Docker安装请参考 `Docker的官网 <https://docs.docker.com/>`_ 。安装好Docker之后可以使用源码目录下的脚本构建文档，即
+
+..  code-block:: bash
+
+    cd TO_YOUR_PADDLE_CLONE_PATH
+    cd paddle/scripts/tools/build_docs
+    bash build_docs.sh with_docker
+
+编译完成后，会在当前目录生成两个子目录\:
+
+* doc 英文文档目录
+* doc_cn 中文文档目录
+
+打开浏览器访问对应目录下的index.html即可访问本地文档。
+
+
+
+直接构建PaddlePaddle的文档
+--------------------------
+
+因为PaddlePaddle的v2 api文档生成过程依赖于py_paddle Python包，用户需要首先确认py_paddle包已经安装。
+
+..  code-block:: bash
+
+    python -c "import py_paddle"
+
+如果提示错误，那么用户需要在本地编译安装PaddlePaddle，请参考 `源码编译文档 <http://www.paddlepaddle.org/develop/doc/getstarted/build_and_install/build_from_source_en.html>`_ 。
+注意，用户在首次编译安装PaddlePaddle时，请将WITH_DOC选项关闭。在编译安装正确之后，请再次确认py_paddle包已经安装，即可进行下一步操作。
+
+如果提示正确，可以执行以下命令编译生成文档，即
+
+..  code-block:: bash
+
+    cd TO_YOUR_PADDLE_CLONE_PATH
+    cd paddle/scripts/tools/build_docs
+    bash build_docs.sh local
+
+编译完成之后，会在当前目录生成两个子目录\:
+
+* doc 英文文档目录
+* doc_cn 中文文档目录
+
+打开浏览器访问对应目录下的index.html即可访问本地文档。
+
+
+如何书写PaddlePaddle的文档
+==========================
+
+PaddlePaddle文档使用 `sphinx`_ 自动生成，用户可以参考sphinx教程进行书写。
+
+如何更新www.paddlepaddle.org文档
+================================
+
+开发者给PaddlePaddle代码增加的注释以PR的形式提交到github中，提交方式可参见 `贡献文档 <http://paddlepaddle.org/develop/doc_cn/howto/dev/contribute_to_paddle_cn.html>`_ 。
+目前PaddlePaddle的develop分支的文档是自动触发更新的，用户可以分别查看最新的 `中文文档 <http://www.paddlepaddle.org/develop/doc_cn/>`_ 和
+`英文文档 <http://www.paddlepaddle.org/develop/doc/>`_ 。
+
+
+
+..  _cmake: https://cmake.org/
+..  _sphinx: http://www.sphinx-doc.org/en/1.4.8/

paddle/scripts/docker/build.sh

@@ -4,9 +4,9 @@ set -xe
 
 # Set BASE_IMAGE according to env variables
 if [ ${WITH_GPU} == "ON" ]; then
-  BASE_IMAGE="nvidia/cuda:8.0-cudnn5-runtime-ubuntu14.04"
+  BASE_IMAGE="nvidia/cuda:8.0-cudnn5-runtime-ubuntu16.04"
 else
-  BASE_IMAGE="ubuntu:14.04"
+  BASE_IMAGE="ubuntu:16.04"
 fi
 
 DOCKERFILE_GPU_ENV=""
@@ -22,6 +22,20 @@ cd /paddle/build
 # build script will not fail if *.deb does not exist
 rm *.deb 2>/dev/null || true
 
+cat <<EOF
+========================================
+Configuring cmake in /paddle/build ...
+      -DCMAKE_BUILD_TYPE=Release
+      -DWITH_DOC=OFF
+      -DWITH_GPU=${WITH_GPU:-OFF}
+      -DWITH_AVX=${WITH_AVX:-OFF}
+      -DWITH_SWIG_PY=ON
+      -DCUDNN_ROOT=/usr/
+      -DWITH_STYLE_CHECK=${WITH_STYLE_CHECK:-OFF}
+      -DWITH_TESTING=${WITH_TESTING:-OFF}
+      -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
+========================================
+EOF
 cmake .. \
       -DCMAKE_BUILD_TYPE=Release \
       -DWITH_DOC=OFF \
@@ -32,49 +46,60 @@ cmake .. \
       -DWITH_STYLE_CHECK=${WITH_STYLE_CHECK:-OFF} \
       -DWITH_TESTING=${WITH_TESTING:-OFF} \
       -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
+
+cat <<EOF
+========================================
+Building in /paddle/build ...
+   Build unit tests: ${WITH_TESTING:-OFF}
+========================================
+EOF
 make -j `nproc`
 if [ ${WITH_TESTING:-OFF} == "ON" ] && [ ${RUN_TEST:-OFF} == "ON" ] ; then
     ctest -V -j `nproc`
 fi
+
+
+cat <<EOF
+========================================
+Installing ...
+========================================
+EOF
 make install
 pip install /usr/local/opt/paddle/share/wheels/*.whl
+paddle version
+
 
-# To build documentation, we need to run cmake twice.
-# This awkwardness is due to https://github.com/PaddlePaddle/Paddle/issues/1854.
-# It also describes a solution.
+# To build documentation, we need to run cmake again after installing
+# PaddlePaddle.  This awkwardness is due to
+# https://github.com/PaddlePaddle/Paddle/issues/1854.  It also
+# describes a solution.
 if [ ${WITH_DOC} == "ON" ]; then
+    cat <<EOF
+========================================
+Building documentation ...
+   In /paddle/build_doc
+========================================
+EOF
     mkdir -p /paddle/build_doc
     pushd /paddle/build_doc
     cmake .. \
           -DWITH_DOC=ON \
           -DWITH_GPU=OFF \
-          -DWITH_AVX=${WITH_AVX:-OFF} \
+          -DWITH_AVX=${WITH_AVX:-ON} \
           -DWITH_SWIG_PY=ON \
           -DWITH_STYLE_CHECK=OFF
     make paddle_docs paddle_docs_cn
-    DOC_DIR="/paddle/paddle/scripts/tools/build_docs/"
-    mkdir -p $DOC_DIR/doc
-    mkdir -p $DOC_DIR/doc_cn
-    cp -r /paddle/build_doc/doc/en/html/* $DOC_DIR/doc
-    cp -r /paddle/build_doc/doc/cn/html/* $DOC_DIR/doc_cn
     popd
-    rm -rf /paddle/build_doc
 fi
-# generate deb package for current build
-cpack -D CPACK_GENERATOR='DEB' ..
+
 
 if [[ ${WOBOQ:-OFF} == 'ON' ]]; then
-    apt-get install -y clang-3.8 llvm-3.8 libclang-3.8-dev
-    # Install woboq_codebrowser.
-    git clone https://github.com/woboq/woboq_codebrowser /woboq
-    cd /woboq
-    cmake -DLLVM_CONFIG_EXECUTABLE=/usr/bin/llvm-config-3.8 \
-          -DCMAKE_BUILD_TYPE=Release \
-          .
-    make -j `nproc`
-
-    export WOBOQ_OUT=/woboq_out/paddle
-    export BUILD_DIR=/paddle/build
+    cat <<EOF
+========================================
+Converting C++ source code into HTML ...
+========================================
+EOF
+    export WOBOQ_OUT=/paddle/build/woboq_out
     mkdir -p $WOBOQ_OUT
     cp -rv /woboq/data $WOBOQ_OUT/../data
     /woboq/generator/codebrowser_generator \
@@ -83,11 +108,36 @@ if [[ ${WOBOQ:-OFF} == 'ON' ]]; then
         -o $WOBOQ_OUT \
         -p paddle:/paddle
     /woboq/indexgenerator/codebrowser_indexgenerator $WOBOQ_OUT
-    cd /woboq
-    make clean
 fi
 
-paddle version
+# generate deb package for current build
+# FIXME(typhoonzero): should we remove paddle/scripts/deb ?
+# FIXME: CPACK_DEBIAN_PACKAGE_DEPENDS removes all dev dependencies, must
+# install them in docker
+cat <<EOF
+========================================
+Generating .deb package ...
+========================================
+EOF
+cpack -D CPACK_GENERATOR='DEB' -D CPACK_DEBIAN_PACKAGE_DEPENDS="" ..
+
+
+cat <<EOF
+========================================
+Generate /paddle/build/Dockerfile ...
+========================================
+EOF
+
+if [ ${WITH_GPU} == "ON" ]; then
+  BASE_IMAGE="nvidia/cuda:8.0-cudnn5-runtime-ubuntu14.04"
+  # additional packages to install when building gpu images
+  GPU_DOCKER_PKG="python-pip python-dev"
+else
+  BASE_IMAGE="python:2.7.13-slim"
+  # FIXME: Python base image uses different python version than WITH_GPU
+  # need to change PYTHONHOME to /usr/local when using python base image
+  CPU_DOCKER_PYTHON_HOME_ENV="ENV PYTHONHOME /usr/local"
+fi
 
 cat > /paddle/build/Dockerfile <<EOF
 FROM ${BASE_IMAGE}

paddle/scripts/tools/build_docs/build_docs.sh

 #!/bin/bash
-set -e
-function usage(){
-        echo "usage: build_doc [--help] [<args>]"
-        echo "This script generates doc and doc_cn in the script's directory."
-        echo "These are common commands used in various situations:"
-        echo "    with_docker       build doc and doc_cn with docker"
-        echo "    local             build doc and doc_cn locally"
-}
-
-
-case "$1" in
-    "with_docker")
-        docker run --rm -v $PWD/../../../../:/paddle \
-            -e "WITH_GPU=OFF" -e "WITH_AVX=ON" -e "WITH_DOC=ON" paddledev/paddle:dev
-        ;;
-    "local")
-        mkdir -p doc
-        mkdir -p doc_cn
-        PADDLE_SOURCE_DIR=$PWD/../../../../
-        mkdir -p $PADDLE_SOURCE_DIR/build_doc
-        pushd $PADDLE_SOURCE_DIR/build_doc
-        cmake .. -DWITH_DOC=ON
-        make paddle_docs paddle_docs_cn
-        popd
-        cp -r $PADDLE_SOURCE_DIR/build_doc/doc/en/html/* doc
-        cp -r $PADDLE_SOURCE_DIR/build_doc/doc/cn/html/* doc_cn
-        rm -rf $PADDLE_SOURCE_DIR/build_doc
-        ;;
-    "--help")
-        usage
-        ;;
-    *)
-        usage
-        ;;
-esac
+docker run --rm \
+       -v $(git rev-parse --show-toplevel):/paddle \
+       -e "WITH_GPU=OFF" \
+       -e "WITH_AVX=ON" \
+       -e "WITH_DOC=ON" \
+       -e "WOBOQ=ON" \
+       ${1:-"paddledev/paddle:dev"}