我正在使用Sphinx autodoc来创建Python文档,然后将其托管在ReadTheDocs上。由ReadTheDocs生成的PDF仅包含我的索引页的目录,您可以在此处查看。
我希望PDF还包含每个模块/函数的整个模块索引和文档:http://sensormotion.readthedocs.io/en/develop/source/sensormotion.html
所以基本上我希望我的索引目录和完整模块页面都合并到同一个 PDF 中
我需要在conf.py
中更改哪些设置才能实现此目的?
目前我只有默认的latex_documents
选项:
latex_documents = [
(master_doc, 'index.tex', project + ' Documentation',
author, 'howto'),
]
我尝试将另一个元组添加到实际模块/函数引用的列表中,但似乎没有附加任何内容附加到 PDF 中:
latex_documents = [
(master_doc, 'index.tex', project + ' Documentation',
author, 'howto'),
('sensormotion', 'sensormotion.tex', project + ' Documentation',
author, 'howto'),
]
您不会从index.rst
引用 docs/source
下的 rst 文件。我认为也许 HTML 构建器会在文档下搜索所有 rst 文件,而 LaTeX 构建器会渲染您在 latex_documents
下明确列出的文件(它为此列表中的每个条目创建一个输出 PDF(。