来自gir文件的基于rest的sphinx文档
gir2rst的Python项目详细描述
gir2rst提供了一个包和命令行工具来创建sphinx文档 来自gobject自省文件。
安装
从github获取最新版本
git clone git://github.com/matze/gir2rst.git
安装时使用:
python setup.py install
您还可以从python包索引中获取最新版本
pip install gir2rst
用法
命令行工具gir2rst将解析提供的.gir文件并输出 stdout上生成的sphinx文档:
usage: gir2rst [-h] [--version] [-t TITLE] [-o FILE] [input [input ...]] Generate Sphinx documentation from GObject Introspection GIR files. positional arguments: input .gir input files optional arguments: -h, --help show this help message and exit --version -t TITLE override the title [available variables: #version (escape with '\')] -o FILE write to FILE or stdout if omitted