我正在使用Sphinx来记录Python模块。
我有一个模块,其中定义了作者和版权。
__author__ = "John Doe <johndoe@example.com>"
__copyright__ = "Copyright 2015-2016 Dummy Corp All Rights Reserved."
我尝试将:special-members:标记添加到automodule指令。
.. automodule:: PyFabric
:special-members:
这是作者的文件,但未获取版权。有没有让狮身人面像识别并添加版权?
答案 0 :(得分:2)
在您的conf.py
中,设置copyright = "© 2042 The Ravenous Bugblatter Beast of Traal"
。
至少对于我使用的html_theme = "sphinx_rtd_theme"
,这将在每个HTML页面的页脚中添加版权声明。
这不会不将版权声明添加到乳胶(和PDF)生成的文档中;在撰写本文时,有一个open feature request。我已经问过如何做到这一点,请参见 How to add copyright notice to sphinx-generated latex documentation? 。
答案 1 :(得分:0)
狮身人面像不使用那些,是吗? https://pythonhosted.org/an_example_pypi_project/sphinx.html
moduleauthor:: John Doe <johndoe@example.com>
无论如何,就我所见,狮身人面像没有那个。
更多python格式化示例:What is the common header format of Python files?