在主文件中包括 Sphinx 生成的文档

在主文件中包括 Sphinx 生成的文档

我目前正在做一个项目(针对大学),将使用 LaTeX 进行记录。大约三分之一的文档将涉及我编写的 Python 模块。

我正在寻找一种干净的方法将 Sphinx 生成的文档包含到我的主文档中。我认为可以修改生成的文档(删除序言、\usepackage在主文件中移动所需的命令、将所有标题下移一级等),然后将其包含进去,但我真的希望有更好的方法。

我认为将 Sphinx 用于整个文档不是一个好主意,因为我对将它用于代码文档以外的其他用途没有信心。

非常感谢任何提示!

答案1

我花了一些时间才弄清楚这一点,但因为我只是想做同样的事情,所以 9 个月后的结果如下:

  1. 复制sphinx.sty 到您的主项目文件夹
  2. 将以下软件包添加到主文件前言中:

    \usepackage{standalone}
    \usepackage{sphinx}
    
  3. 像这样包含你的 sphinx 文档:

    \part*{Appendix}
    \phantomsection
    \addcontentsline{toc}{part}{Appendix}
    \appendix
    \def\maketitle{}
    \def\tableofcontents{}
    \input{../project_name/doc/_build/latex/project_name}
    

这会在目录中添加一个漂亮的未编号部分,并为所有文档部分提供字母作为章节编号。它对我来说完全没有改变 sphinx LaTeX 输出。

相关内容