Odoo 文档生成

2017-10-31 1733点热度 0条评论

Sphinx 使用 reStructuredText 标记语法(和其他一些语法)来提供文档控制。如果您之前编写过纯文本文件,那么您可能非常了解精通 Sphinx 所需的语法。

Odoo也是采用这种文档书写!

当然官方也提供了这么一份文档:http://www.odoo.com/documentation/user/10.0/index.html

但国内访问实在是太慢了。。这里我们自己生成一份最新的版本!

安装Sphinx

# 安装支持库
yum install -y epel-release
yum install python-pip python-wheel python-setuptools python-devel gcc

# 安装sphinx
pip install -U sphinx
pip install -U werkzeug

# 查看程序版本信息
sphinx-build --version

构建用户文档

# 拉取最新的文档
git clone https://github.com/odoo/documentation-user.git

# 生成(可以直接执行make查看生成格式)
cd documentation-user
make html 

构建开发文档

# 新建仓库并进入文件夹
git init odoo_doc && cd odoo_doc
# 设置允许克隆子目录
git config core.sparsecheckout true
# 设置要克隆的仓库的子目录路径
echo '/doc/' >> .git/info/sparse-checkout
# 设置Odoo远程仓库
git remote add origin https://github.com/odoo/odoo.git
# 拉取远程分支
git pull origin master

cd doc
make html

Jalena

原创内容,转载请注明出处! 部分内容来自网络,请遵守法律适用!

文章评论