【问题标题】:Sphinx PDF output does not include auto-generated documentation from codeSphinx PDF 输出不包括从代码自动生成的文档
【发布时间】:2021-08-12 07:22:02
【问题描述】:

我将以下conf.py 用于python 项目。 html 生成的文件很好,并提供了代码自动生成的文档,但 pdf 文件几乎是空的,只包含 rst 文件中的内容。


import os
import sys
import stanford_theme

sys.path.insert(0, os.path.abspath('..'))

extensions = ['sphinx.ext.todo',
              'sphinx.ext.viewcode',
              'sphinx.ext.autodoc',
              'sphinx.ext.githubpages',
              # 'sphinxcontrib.plantuml',
              'sphinx.ext.inheritance_diagram',
              'sphinx.ext.coverage',
              'sphinx.ext.napoleon',
              'sphinx.ext.imgmath',
              'sphinx.ext.mathjax'
              ]

templates_path = ['_templates']
exclude_patterns = ['_build']
html_theme = 'stanford_theme'
html_theme_path = [stanford_theme.get_html_theme_path()]
html_static_path = ['_static']


latex_elements = {
    'papersize': 'letterpaper',
    'pointsize': '12pt',
    'preamble': r"""
\usepackage{setspace}
"""
}

我用

make latex
cd build/latex
make

生成pdf文件。 如何制作 pdf 文件,包括从源代码自动生成的文档。 我在 Ubuntu 20.04 机器上使用 Sphinx(我认为是最新版本)。

【问题讨论】:

  • 如果问题看起来太明显,我可能需要删除它。
  • 删除问题或发布答案。问题的解决方案不应该出现在问题中。

标签: python latex python-sphinx autodoc


【解决方案1】:

我找到了: 自动生成的代码在 rst 文件中生成:

Auto Generated Documentation 
==============================

.. automodule:: visualization
    :members:

我引用 index.rst 中的文件

.. toctree::
   :maxdepth: 2

   code

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2012-06-30
    • 1970-01-01
    • 2018-09-07
    • 2014-12-19
    • 1970-01-01
    • 2011-07-22
    • 1970-01-01
    相关资源
    最近更新 更多