编译ceph官网文档,输出为pdf格式

###编译过程:java

以ubuntu系统为例:python

  • 在ceph源码根目录/home/ceph-master执行./admin/build-doc。根据提示安装全部须要的依赖包,如: python-dev python-pip python-virtualenv doxygen ditaa ant 或者 python-devel python-pip python-virtualenv doxygen ditaa ant libxml-devel libxslt-develgit

  • 安装好python pip后,安装shpinx: 执行pip install -U Sphinxgithub

  • 为了使用pdflatex命令,须要安装texlive(时间较长): sudo apt-get install texliveapache

  • 在doc目录,执行: git clone https://github.com/baloo/sphinx-ditaaubuntu

  • 修改doc目录下的conf.py文件:app

import sys
sys.path.append(os.path.abspath('sphinx-ditaa'))
sys.path.append(os.path.abspath('sphinx-ditaa/sphinxext'))

extensions = [ 
    'sphinx.ext.autodoc',
    'sphinx.ext.graphviz',
    'sphinx.ext.todo',
    'ext.ditaa',
    'breathe',
    ]
  • 安装breathe: pip install breatheui

  • ditaa(http://ditaa.sourceforge.net/)和 ant(http://ant.apache.org )是基于java的,和其余依赖包不同。 ant下载后,将bin加入PATH变量便可。ditaa后面说。spa

  • 在ceph-master/dddd目录下生成 tex 文件: sphinx-build -b latex ./doc ./dddd.net

若是没有问题,你能够在dddd目录下看到Ceph.tex文件。

  • 由 tex 文件转换为pdf文件: pdflatex Ceph.tex 中途若是卡住,按回车跳过便可。

###说明:

  1. 若是pdflatex遇到`picins.sty' not found问题,参考:http://my.oschina.net/itfanr/blog/479470

  2. 若是发现ditaa没有在_images目录下自动生成png图片,能够手动经过ditaa来生成:

for name in  `ls  /home/ceph-master/dddd/_images/`;do  java -jar ditaa0_9.jar /home/ceph-master/dddd/_images/$name;done
相关文章
相关标签/搜索