restructuredtext - reStructuredText 中的选项列表，用于不以破折号或斜杠为前缀的命令行参数-6ren

restructuredtext - reStructuredText 中的选项列表，用于不以破折号或斜杠为前缀的命令行参数

转载作者：行者123 更新时间：2023-12-04 07:25:38

reStructuredText 对 option lists 有很好的支持.例如，rst2html.py翻译这个 RST 标记

Options:
    --foo                 does a foo
    -b, --bar ABAR        bar something

进入以下格式良好的 HTML 表格:

<dt>Options:</dt>
<dd><table class="first last docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">--foo</span></kbd></td>
<td>does a foo</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-b</span>, <span class="option">--bar <var>ABAR</var></span></kbd></td>
<td>bar something</td></tr>
</tbody>
</table>
</dd>

然而，这似乎并没有自然地扩展到位置参数；例如

Arguments:
    foo                   does a foo
    bar ABAR              bar something

呈现为完全没有表格结构的 HTML:

<dt>Arguments:</dt>
<dd>foo                   does a foo
bar ABAR              bar something</dd>

有没有什么方法可以为命令行参数生成一个选项列表，这些参数不是以破折号或斜杠为前缀的？

最佳答案

是的。选项列表的相当有限的语法在这里没有很好地记录: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists

这是真正令人恼火的事情。假设您正在编写一系列选项，并且其中一些符合前面链接中“选项”的语法，但有些则不符合。例如 --opt==keyword 会(无论您是否愿意，“关键字”都会以斜体显示)，但 --pot=BLACK|KETTLE 不会. Docutils 会将所有符合其语法的内容放入一个漂亮的选项列表

s。因此，在您的一堆选项中间，有一些看起来不像其他选项。

关于restructuredtext - reStructuredText 中的选项列表，用于不以破折号或斜杠为前缀的命令行参数，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/13810238/