Поле автора не обновляется в HTML-сборке Sphinx для пакета Python - PullRequest
0 голосов
/ 08 июня 2018

Мы создаем документацию для пакета Python.Изначально в файле init .py в заголовочную строку документа записывался только один автор:

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


:author: Name <email>


"""

, но у нас есть другой автор, и я пытался добавить этого автораразличными способами: превращение его в список, добавление другого: author :, запись 'и' между обоими именами, но, похоже, ничего не получалось, и он просто отображал первоначального автора.Я пробовал много вещей, чтобы проверить, не изменилось ли оно даже в html, например: изменение файла конфигурации для включения show_authors, очистка кеша и удаление соответствующего файла доктрины пакета, и выполнение sphinx-build -a -E в папкеи построить его с нуля.Я снова попытался выполнить make clean и запустить make html, и я несколько раз устанавливал пакет на python, чтобы убедиться, что код был обновлен.Я обновил первый файл, чтобы убедиться, что sphinx обнаружил изменения в проекте и, похоже, ничего не работает.Я сделал все это с совершенно другим автором, написанным в строке документации, и html документации, автоматически созданной sphinx, по-прежнему отображает того же самого первоначального автора.Я прочитал документацию, и ничто не было действительно полезным, кроме вещей config.py, но они тоже не работали.Я попытался пересоздать документы для этого конкретного пакета с совершенно другим автором, жестко закодированным в команде sphinx-apidoc с параметром -A, и тот же автор все еще отображается.Я даже начал думать, что 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:
...