是什么导致 sphinx 输出 'WARNING: Unexpected indentation'？

Question

我想知道为什么当我运行 make htmldocs 时，下面的 reStructuredText 文件会在第 2 行抛出警告 'Unexpected Indentation'。有关如何获取更多详细日志的信息警告会有所帮助。

我试过去掉第1行末尾的斜杠，在第2行上下添加空行，并确保第1行和第2行之间的间距类型相同，但没有骰子。

What:       /sys/firmware/sgi_uv/
Date:       September 2020
Contact:    Justin Ernst <justin.ernst@hpe.com>
Description:
        The /sys/firmware/sgi_uv directory contains information
        about the UV platform.

        Under that directory are a number of read-only attributes::

            archtype
            hub_type
            hubless
            partition_id
            coherence_id
            uv_type

        The archtype entry contains the UV architecture type that....

下面的文档没有发出警告，尽管我看不出两者的格式有什么区别：

What:       /sys/firmware/sfi/tables/
Date:       May 2010
Contact:    Len Brown <lenb@kernel.org>
Description:
        SFI defines a number of small static memory tables

干杯，米兰

Answer 1

您的语法不正确。我想你想使用字段列表，或者可能是定义列表，这取决于你是否希望结果在呈现时对 reader 可见。在 https://livesphinx.herokuapp.com/.

上试用

Field List

:What:       /sys/firmware/sgi_uv/
:Date:       September 2020
:Contact:    Justin Ernst <justin.ernst@hpe.com>
:Description: The /sys/firmware/sgi_uv directory contains information
    about the UV platform.

    Under that directory are a number of read-only attributes:

        archtype
        hub_type
        hubless
        partition_id
        coherence_id
        uv_type

    The archtype entry contains the UV architecture type that....

Definition List

What:
    /sys/firmware/sgi_uv/

Date:
    September 2020

Contact:
    Justin Ernst <justin.ernst@hpe.com>

Description:
    The /sys/firmware/sgi_uv directory contains information
    about the UV platform.

    Under that directory are a number of read-only attributes::

        archtype
        hub_type
        hubless
        partition_id
        coherence_id
        uv_type

    The archtype entry contains the UV architecture type that....

是什么导致 sphinx 输出 'WARNING: Unexpected indentation'？

What is causing sphinx to output 'WARNING: Unexpected indentation'?

documentation

restructuredtext

python-sphinx

Field List

Definition List