3

我正在使用 Sphinx 来记录 Python 模块。

我有一个定义了作者和版权的模块。

__author__ = "John Doe <johndoe@example.com>"
__copyright__ = "Copyright 2015-2016 Dummy Corp All Rights Reserved."

我尝试将 :special-members: 标签添加到 automodule 指令中。

.. automodule:: PyFabric
   :special-members:

这记录了作者，但没有获得版权。有没有办法让 Sphinx 识别并添加版权？

4

2 回答 2

2

在您的conf.py, 设置copyright = "© 2042 The Ravenous Bugblatter Beast of Traal".

请参阅sphinx-doc 文档。

至少对于html_theme = "sphinx_rtd_theme"我使用的，这将在每个 HTML 页面的页脚中添加版权声明。

这不会将版权声明添加到乳胶（和 PDF）生成的文档中；在撰写本文时有一个开放的功能请求。我已经问过如何做到这一点，请参阅如何将版权声明添加到 sphinx 生成的乳胶文档中？.

于 2019-01-11T13:07:08.200 回答
0

狮身人面像不使用这些，是吗？ https://pythonhosted.org/an_example_pypi_project/sphinx.html

moduleauthor:: John Doe <johndoe@example.com>

无论如何，就我所见，狮身人面像没有那个。

更多python格式化示例：Python文件常见的头格式是什么？

于 2016-04-08T17:18:54.133 回答