如何修改Read The Docs默认PDF下载设置?含自定义样式与单页下载
修改Read The Docs PDF下载设置的可行方案
1. 自定义PDF样式
Read The Docs基于Sphinx构建文档,可通过配置Sphinx的LaTeX参数定制PDF样式:
- 在项目的
conf.py文件中,修改latex_elements字典,添加自定义LaTeX配置,比如调整页面尺寸、字体、页眉页脚等,示例代码:
latex_elements = { 'papersize': 'a4paper', 'pointsize': '12pt', 'preamble': r''' \usepackage{fontspec} \setmainfont{Arial} \usepackage{fancyhdr} \pagestyle{fancy} \fancyhead[L]{我的文档页眉} \fancyfoot[C]{\thepage} ''' }
- 若需要更复杂样式,可创建自定义
.sty文件,再在preamble中通过\usepackage{your-style-file}引入。 - 注意:如果用到特殊LaTeX包,需在Read The Docs项目设置的「系统依赖」中添加对应TeX Live包,或在依赖文件中声明相关工具。
2. 支持单篇文章PDF下载+保留完整手册功能
默认Read The Docs仅生成整个项目的PDF,要实现单篇下载同时保留完整手册,可通过配置Sphinx多PDF输出来实现:
- 在
conf.py的latex_documents中,先保留完整手册配置,再添加单篇文档输出项,示例:
# 完整手册的PDF配置 master_doc = 'index' latex_documents = [ (master_doc, 'FullProjectManual.tex', '项目完整手册', '作者名称', 'manual'), ] # 添加单篇文档的PDF输出 latex_documents.extend([ ('guides/quick-start', 'QuickStartGuide.tex', '快速入门指南', '作者名称', 'howto'), ('reference/api-details', 'APIDetails.tex', 'API详细说明', '作者名称', 'howto'), ])
- 构建完成后,Read The Docs会生成多个PDF文件,你可在文档页面中添加下载链接,指向对应单篇PDF文件。
- 也可通过Sphinx的
sphinx-build命令单独构建单篇文档的PDF,再上传到项目静态资源目录,但更推荐通过conf.py配置自动生成,避免手动维护。
内容的提问来源于stack exchange,提问作者Michael Wynne
相关产品推荐
相关产品推荐

