如何将OpenCascade(OCCT)官方文档编译生成单个完整PDF文件
OCCT 单全量PDF文档生成操作步骤
前置依赖准备
首先确保本地环境已安装以下组件:
- TeX Live 2020 及以上完整版本(需包含pdftex、latexmk、数学公式渲染包、中文字体包等全套PDF编译组件,不推荐使用裁剪版的MikTeX)
- Python 3.7 及以上版本
- 完整OCCT源码包(需包含
gendoc工具目录和所有.rst格式的文档源文件,第三方裁剪的发行版源码通常会移除文档源)
生成操作流程
- 依赖检查
进入OCCT源码根目录,执行依赖校验命令:python3 gendoc/requirements.py
如果提示缺失Python依赖包,直接用pip安装对应包即可。 - 参数配置
打开gendoc/config/custom_config.py配置文件,修改以下核心参数:
- 将
OUTPUT_FORMAT设置为仅保留PDF输出:OUTPUT_FORMAT = ['pdf'] - 开启PDF合并开关:
COMBINE_PDF = True,该参数是生成单份全量PDF的核心控制项 - 可按需修改
PDF_TITLE自定义生成文件的标题,比如改为OpenCasCade Technology [你的OCCT版本号] 官方文档
- 执行编译
在源码根目录执行全量文档生成命令:python3 gendoc/gen_doc.py --all
全量文档包含所有模块的接口说明、示例、原理讲解,编译过程涉及大量公式、图表渲染,首次生成耗时通常在30~90分钟,取决于机器性能,全程等待执行结束即可。
常见问题说明
如果编译中途弹出TeX相关报错,优先检查TeX Live是否安装完整,缺失的组件可以通过
tlmgr install [组件名]命令补装
如果不需要全模块文档,可将命令中的--all替换为指定模块名,比如--module ModelingData,ModelingAlgorithms即可生成对应模块的合并PDF
内容的提问来源于stack exchange,提问作者Alex Luya
相关产品推荐
相关产品推荐

