ReadTheDocs Sphinx: ВНИМАНИЕ: список полей заканчивается пустой строкой; неожиданный отступPython

Программы на Python
Ответить Пред. темаСлед. тема
Anonymous
 ReadTheDocs Sphinx: ВНИМАНИЕ: список полей заканчивается пустой строкой; неожиданный отступ

Сообщение Anonymous »

Я документирую свой пакет Python с помощью Sphinx. Но я столкнулся с несколькими предупреждениями, и понятия не имею, что делать. Все они встречаются в строках документации на уровне модуля, а не внутри классов или методов.
При попытке собрать документацию на ReadTheDocs я получаю следующую ошибку:

Код: Выделить всё

/home/docs/checkouts/readthedocs.org/user_builds/project/checkouts/latest/project/vqe_optimization.py:docstring of project.optimization:1: WARNING: Field list ends without a blank line; unexpected unindent.
/home/docs/checkouts/readthedocs.org/user_builds/project/checkouts/latest/project/optimization.py:docstring of project.vqe_optimization:1: WARNING: Field list ends without a blank line; unexpected unindent.
/home/docs/checkouts/readthedocs.org/user_builds/project/checkouts/latest/project/optimization.py:docstring of project.vqe_optimization:3: WARNING: Definition list ends without a blank line; unexpected unindent.
Меня это совершенно озадачивает, поскольку моя строка документации выглядит так:

Код: Выделить всё

"""Module containing the core Project engine.

Core Project module comprising implementation of the core Project solver
class together with optimizer interfaces etc. The module aims to contain
all the logic behind Project solution, which is not directly connected to
the properties of the electronic structure problem being solved or to the
properties of logically-independent circuits
like an initial orthogonal set or an ansatz.
"""
Вот я совсем озадачен... Что неверно в первой и третьей строке?
В моем conf.py Я использую эти расширения:

Код: Выделить всё

extensions = [
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'myst_parser',
'nbsphinx',
'nbsphinx_link',
'sphinx.ext.autodoc'
]
Ссылка на журнал сборки моего проекта находится здесь: https://readthedocs.org/api/v2/build/25619818.txt

Подробнее здесь: https://stackoverflow.com/questions/789 ... xpected-un
Реклама
Ответить Пред. темаСлед. тема

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

  • Похожие темы
    Ответы
    Просмотры
    Последнее сообщение
  • ReadTheDocs Sphinx: ВНИМАНИЕ: список полей заканчивается пустой строкой; неожиданный отступ
    Anonymous » » в форуме Python
    0 Ответы
    25 Просмотры
    Последнее сообщение Anonymous
  • ReadTheDocs Sphinx: ВНИМАНИЕ: список полей заканчивается пустой строкой; неожиданный отступ
    Anonymous » » в форуме Python
    0 Ответы
    14 Просмотры
    Последнее сообщение Anonymous
  • Можно ли подавить ошибку «Неожиданный отступ» с помощью sphinx?
    Anonymous » » в форуме Python
    0 Ответы
    14 Просмотры
    Последнее сообщение Anonymous
  • Проблемы с Sphinx Autodoc и Readthedocs
    Anonymous » » в форуме Python
    0 Ответы
    15 Просмотры
    Последнее сообщение Anonymous
  • Почему версии sphinx-build и sphinx в моей ОС различаются?
    Anonymous » » в форуме Python
    0 Ответы
    25 Просмотры
    Последнее сообщение Anonymous

Вернуться в «Python»