Question

我们正在构建python包的文档。最初， init .py文件只有一个作者写入标题文档字符串，如下所示：

"""
TITLE
--------------------


:author: Name <email>


"""

但是我们有另一位作者，我一直在努力以各种方式添加这个作者：将其变成一个列表，添加另一个：author：，在两个名称之间写'和'，但似乎没有任何工作它只是显示原作者。我尝试了很多东西来检查它是否甚至在html中更改，例如：更改配置文件以包含show_authors，通过擦除包的相应doctree文件清除缓存，以及在文件夹上执行sphinx-build -a -E并从头开始构建它。我尝试make clean并再次运行make html，我python多次安装包以确保代码已更新。我更新了第一个文件，以确保sphinx检测到项目中的更改，似乎没有任何效果。我使用docstring中编写的完全不同的作者完成了所有这些操作，sphinx自动构建的文档html仍显示相同的初始作者。我阅读了文档，除了config.py之外什么都没有用，但是那些也没有用。我尝试使用-A选项在sphinx-apidoc命令中使用硬编码的完全不同的作者重新构建该特定包的文档，同时仍然显示相同的作者。我甚至开始认为Chrome正在缓存网站，所以我清除了缓存，结果仍然相同。如果我更改了包的.rst文件，文档会完美更新，那么这个作者标签就不会改变。

这是我缺少的东西吗？有没有办法硬编码特定包的作者，而无需重新创建项目的文档？我们不是该项目的唯一贡献者，并且我们无法对其进行更改，因此运行sphinx-quickstart不是一种选择。

以下是conf.py中提及作者选项的部分：

author = setup_cfg['author']
copyright = '{0}, {1}'.format(
    datetime.datetime.now().year, setup_cfg['author'])
show_authors = True

和

man_pages = [('index', project.lower(), project + u' Documentation',
          [author], 1)]

这是我认为正在进行所有这些之间链接的.rst文件的部分：

.. doctest-skip-all

.. _directory.package:

Reference/API
=============

.. automodapi:: directory.package
    :no-inheritance-diagram:

作者字段未在Sphinx html构建中更新python包

0 个答案: