背景信息
本节给出在Ubuntu 16.04.3系统中进行PaddlePaddle文档构建的方法。
PaddlePaddle官网提供了PaddlePaddle.org工具的Docker镜像包,因此可以将本地包含源文档库的工作目录挂载到PaddlePaddle.org容器中,来进行文件构建。
前提条件
- 已在Ubuntu系统中安装Docker服务。
- Ubuntu系统中的8000端口未被占用。
- 已完成paddlepaddle.org镜像的下载(下载命令:docker pull paddlepaddle/paddlepaddle.org)
操作步骤
1、以root用户登录Ubuntu操作系统的CLI控制台。
2、创建PaddlePaddle工作目录。
mkdir /home/paddlepaddle
cd /home/paddlepaddle
3、使用git工具克隆代码库。
git clone https://github.com/PaddlePaddle/Paddle.git
git clone https://github.com/PaddlePaddle/book.git
git clone https://github.com/PaddlePaddle/models.git
git clone https://github.com/PaddlePaddle/Mobile.git
4、启动paddlepaddle.org容器。
启动paddlepaddle.org容器时需要将本地的工作目录挂载到容器中,如下所示:
docker run -it -p 8000:8000 -v `pwd`:/var/content paddlepaddle/paddlepaddle.org:latest
上述命令中使用参数-v将当前目录(pwd命令返回当前目录的绝对路径)挂载到容器的“/var/context/"目录下 https://github.com/PaddlePaddle/book.git
5、在浏览器中输入http://IP:8000访问PaddlePaddle文档查看器主页。
其中IP为Ubuntu系统的IP地址。
PaddlePaddle文档查看器主页如下图所示:
6、在单击代码库名称生成文档。
在PaddlePaddle文档查看器主页单击对应的代码库后,系统会将生成的文档保存在<paddlepaddle workingdirectory>/.ppo_workspace/content目录下,目录结构如下图所示: