我想在幾個節標題之間顯示兩個函數的文檔字符串，如下所示：===API===.. autofunction:: parsons.aws.distribute_task.. autofunction:: parsons.aws.event_command***S3***兩個文檔字符串都出現在渲染的 HTML 中，但第二個函數還將 Sphinx 指令顯示.. autofunction:: parsons.aws.event_command為文檔字符串下方的文本：關于為什么會發生這種情況以及如何擺脫它有什么想法嗎？您可以在 GitHub 上此文件的頂部看到問題（以及該項目的所有代碼）：https://github.com/move-coop/parsons/blob/master/docs/aws.rst在文檔的構建版本中：https://move-coop.github.io/parsons/html/aws.html
1 回答
PIPIONE
TA貢獻1829條經驗 獲得超9個贊
GitHub 上的代碼沒有空行分隔兩個.. autofunction::指令：
.. autofunction :: parsons.aws.distribute_task
.. autofunction :: parsons.aws.event_command
指令的 reStructuredText 規則 指出：
響應指令而采取的操作以及指令內容塊或*后續文本塊中的文本解釋取決于指令。
因此，查看“語法圖”和指令塊的“三個邏輯部分” ：
There are three logical parts to the directive block:
? ? Directive arguments.
? ? Directive options.
? ? Directive content.
(...)
Syntax diagram:
+-------+-------------------------------+
| ".. " | directive type "::" directive |
+-------+ block? ? ? ? ? ? ? ? ? ? ? ? ?|
? ? ? ? |? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?|
? ? ? ? +-------------------------------+
對我來說，尚不完全清楚“后續文本塊”（將具有指令相關行為）是否適用于緊隨另一個指令的指令，或者僅適用于“指令塊的三個邏輯部分”。
指令算作顯式標記塊，因此第三條規則意味著指令應在未縮進的行之前結束。
顯式標記塊是文本塊：(...)
它在未縮進的行之前結束。
請注意，這兩個指令之間沒有明確的結尾.. autofunction::（兩者都沒有縮進）。進一步指出：
顯式標記塊和其他元素之間需要空行，但在明確的標記塊之間可以選擇空行。
通常在指令后添加空行會更安全，以防止任何未指定的行為（在您的情況下，讓指令正常渲染并以文本方式包含）。
如果您在指令后留下一個空行，它應該按預期工作。
添加回答
舉報
0/150
提交
取消