python - sphinx 在构建期间不包含源代码

标签 python python-sphinx

我正在尝试使用 Sphinx 1.2.1 记录我的 python 包。

我对第一个文件的定义包含了一些关于每个模块的描述、使用和为重组文本添加 autodoc 语法,如下所示。

module
------

.. automodule:: RAT.REPORTER.bemrstcreator
    :members:
    :undoc-members:
    :show-inheritance:

以上设置为我创建了一个清晰的 html 构建,没有任何问题。它从所有类及其关联成员等派生文档,但它在 html 中包含源代码。如何让sphinx不链接各个模块的源码?

最佳答案

您可以在 config.py 文件中找到下一个配置值,并将其设置为 false:

html_show_sourcelink = False

关于python - sphinx 在构建期间不包含源代码,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/22714788/

相关文章:

python-sphinx - 使文档的标题级别自动依赖于它们所属的 (sub(sub(...))) 文件夹的深度级别

python - 狮身人面像 : What is the cause for 'WARNING: duplicate object description' ?

带有 Sphinx 文档的 Python 模块引用

python - Django-url 中的 "name"是什么意思?

python - 在 .py 文件中引用 django 中的静态文件(不在模板中)

python - "No module named time"

python - scipy.sparse.csr_matrix.toarray() 的大量内存使用

python - 使用深度学习从序列中预测子序列

java - 使用 Python-Sphinx 解析 javadoc

image - 使用image指令的target属性的类似缩略图的行为