Created by: wangkuiyi
This PR has been updated to fix https://github.com/PaddlePaddle/Paddle/issues/732.
The intention of this PR is to add an additional type of documentation. When I am learning Paddle, I do need this document. Also, a new user asked the same question in https://github.com/PaddlePaddle/Paddle/issues/715. I feel that before Paddle API is fully stable, this document would be useful for many users.
What I did is to edit our Dockerfile so that
- make cmake records all build commands into a JSON file, and
- install woboq code browser which follows the JSON file to convert all .cc/.h files into .html for convenient code browsing.
This idea was from my earlier work at https://github.com/wangkuiyi/paddle-code-browse.
If this PR is merged, we can run a Nginx container to serve browsable .html files as the following:
# load documents in a container paddle-cpu-doc
docker run -d --name paddle-cpu-doc paddle:cpu
# run nginx to serve documents in paddle-cpu-doc
docker run -d --volumes-from paddle-cpu-doc -p 8088:80 nginx