FreeType的API参考文档生成器。
docwriter的Python项目详细描述
自由类型docwriter
docwriter是freetype库的api文档生成器，它从freetype头文件中提取和构建标记文档。
安装
运行pip install docwriter（有关自动使用virtualenv的信息，请参见下面的（4）。它需要Python2.7+或3.4+才能运行。
生成文档的步骤
确保使用
pip安装docwriter。从here克隆freetype2存储库。
FreeType生成系统可用于生成文档：
sh autogen.sh ./configure make refdoc或者，步骤1和make目标可以替换为
make refdoc-venv。这将在单独的虚拟环境中自动安装所有需求。有关virtualenv用法的更多信息，请参见here。
开发使用
克隆此存储库。
从here克隆freetype2存储库。
在您的环境中运行
pip install -r requirements.txt（推荐使用virtualenv）。将
include/目录从freetype2复制到docwriter。在
docwriter目录中运行：python -m docwriter \ --prefix=ft2 \ --title=FreeType-2.9.1 \ --output=./docs/reference \ ./include/freetype/*.h \ ./include/freetype/config/*.h \ ./include/freetype/cache/*.h
标记文件应该在
docs/reference/markdown/中生成。静态站点可以通过在docs/reference中运行mkdocs build来呈现。阅读有关mkdocshere的更多信息。
使用信息
docwriter [-h] [-t T] -o DIR [-p PRE] [-q | -v] files [files ...]
DocWriter Usage information
positional arguments:
files list of source files to parse, wildcards are allowed
optional arguments:
-h, --help show this help message and exit
-t T, --title T set project title, as in '-t "My Project"'
-o DIR, --output DIR set output directory, as in '-o mydir'
-p PRE, --prefix PRE set documentation prefix, as in '-p ft2'
-q, --quiet run quietly, show only errors
-v, --verbose increase output verbosity
运行测试
有两种可能的测试方案：
- 在py27和py36上运行测试（使用tox-需要安装两个python版本）。
- 在当前安装的python版本上运行测试。
具体如下。
使用毒物进行测试
在PY27和PY36上测试：
确保
tox已安装：pip install tox
确保PY27和PY36都可用。
运行测试：
tox
在单个python版本上测试
使用pytest在当前python版本上测试：
确保
pytest已安装：pip install pytest
运行测试：
cd tests/ python -m pytest
许可证
这个库是根据FreeType License授权的。
历史记录
这个图书馆最初是由david turner写成的docmaker，它收集并呈现
HTML文档。它已经被多次修改，包括一个主要的重构
允许多种输出格式。当前的docwriter是最大的重写，有很多
允许其更灵活、可读、可维护和可用的更改和添加。
欢迎加入QQ群-->： 979659372
