行内元素

Sphinx 启用特定的行内文本片段。这些片段通过语义标记强调，从而以不同的样式格式化文本。

根据其语义含义，一致地使用本节中包含的标记。

注意

应用于代码块元素内的文本片段时，语义标记不起作用。

要将语义标记插入到文档中，请使用以下语法。

语法

:markup:`inline text`

应用

行内文本中的软件应用程序。

标记

`` (双反引号)

语法

``RabbitMQ``

输出示例

配置 RabbitMQ。

代码

行内文本中的代码片段。

标记

`` (双反引号)

语法

``m1.small``

输出示例

以下命令使用 m1.small flavor 启动实例。

命令

命令行界面中的内联子命令以及不同操作系统中的内联命令。

标记

:command

语法

:command:`nova boot`

输出示例

运行 nova boot 命令以启动实例。

文件名和路径

路径规范的任何部分，包括设备名称、目录、文件名和扩展名。

标记

`` (双反引号)

语法

``nova.conf``

输出示例

默认情况下，nova.conf 配置文件安装在 /etc/nova 文件夹中。

术语表条目

术语表中出现的一个术语。

标记

:term

语法

:term:`neutron` 或 :term:`services <service>`

输出示例

OpenStack neutron 提供与网络相关的 services。

GUI 元素

交互式用户界面的任何部分。

标记

:guilabel

语法

:guilabel:`Project`

输出示例

从 Project 选项卡，您可以查看和管理所选项目的资源。

键盘按键组合

两个或多个击键或鼠标操作的序列。

标记

`` (双反引号)

语法

``Ctrl+A``

输出示例

按下 Ctrl+A 以在服务之间切换。

参数

命令行界面中子命令的任何参数。

标记

`` (双反引号)

语法

`` --template-url`` 或 ``back end``

输出示例

  • 您可以使用 --template-url 参数指定 URL。

  • 设置 back end 参数。

选项

命令行界面中子命令的任何选项或配置选项。

标记

`` (双反引号)

语法

`` --parent``, ``force_dhcp_release = True``

输出示例

  • --parent 表示项目的父项（名称或 ID）。

  • force_dhcp_release = True 选项在实例终止时发送 dhcp 释放。

注意

记录布尔配置选项时

  • 显式包含真值

  • 在等号 (=) 周围添加空格

正确用法

force_dhcp_release = True
use_ipv6 = False

变量

包含用大括号括起来的变量部分的文字。

标记

:samp: 用于标记带有大括号的变量。不要对可替换文本添加任何额外的格式。

语法

:samp:`--flavor {FLAVOR}`

输出示例

使用 --flavor FLAVOR 参数指定 flavor 的 ID 或名称。