PyData 主题元素

PyData 主题元素#

这是一组内容块，由该主题的父主题 PyData Sphinx 主题 提供特殊支持。

这个主题有一些独特或特别重要的元素。其中一些元素通过该主题独有的配置或 Markdown 语法触发，我们将在下面介绍它们。

数学#

大多数 Sphinx 站点都支持数学公式，但对于科学计算来说，这一点尤为重要，因此我们在这里也展示了相关支持。

以下是行内公式：\(X_{0:5} = (X_0, X_1, X_2, X_3, X_4)\) 以及 \(another\) 和 \(x^2 x^3 x^4\) 另一个。这里还有测试垂直高度的公式：\(\frac{\partial^2 f}{\partial \phi^2}\)。以下是块级公式：

(1)#\[\nabla^2 f = \frac{1}{r^2} \frac{\partial}{\partial r} \left( r^2 \frac{\partial f}{\partial r} \right) + \frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial \theta} \left( \sin \theta \, \frac{\partial f}{\partial \theta} \right) + \frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial \phi^2}\]

这里是带有标签的非常长的公式！

(2)#\[\nabla^2 f = \frac{1}{r^2} \frac{\partial}{\partial r} \left( r^2 \frac{\partial f}{\partial r} \right) + \frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial \theta} \left( \sin \theta \, \frac{\partial f}{\partial \theta} \right) + \frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial \phi^2} \nabla^2 f = \frac{1}{r^2} \frac{\partial}{\partial r} \left( r^2 \frac{\partial f}{\partial r} \right) + \frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial \theta} \left( \sin \theta \, \frac{\partial f}{\partial \theta} \right) + \frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial \phi^2}\]

你可以添加指向上述方程的链接，例如 (1) 和 (2)。

代码块#

代码块样式灵感源自 GitHub 的代码块样式，并且还支持代码块的标题/说明。更多信息请参阅 Sphinx 关于代码块的文档。

print("A regular code block")
print("A regular code block")
print("A regular code block")

你还可以为代码块提供说明，这些说明将显示在代码的正上方。例如，以下代码：

.. code-block:: python
    :caption: python.py

    print("A code block with a caption.")

```{code-block} python
:caption: python.py

print("A code block with a caption.")
```

results in:

列表 1 python.py#
print("A code block with a caption.")

你还可以显示行号。例如，以下代码：

..  code-block:: python
    :caption: python.py
    :linenos:

    print("A code block with a caption and line numbers.")
    print("A code block with a caption and line numbers.")
    print("A code block with a caption and line numbers.")

```{code-block} python
:caption: python.py
:linenos:

print("A code block with a caption and line numbers.")
print("A code block with a caption and line numbers.")
print("A code block with a caption and line numbers.")
```

results in:

列表 2 python.py#
1print("A code block with a caption and line numbers.")
2print("A code block with a caption and line numbers.")
3print("A code block with a caption and line numbers.")

内联代码#

直接使用时，code 角色仅以字面形式显示文本，不进行语法高亮。如 Sphinx 文档 中所述，你还可以通过定义自定义角色来启用语法高亮。之后，它将使用与 code-block 指令相同的语法高亮器。

.. role:: python(code)
   :language: python

In Python you can :python:`import sphinx`.

```{role} python(code)
:language: python
```

In Python you can {python}`import sphinx`.

在 Python 中，你可以 import sphinx。

代码执行#

此主题支持 Jupyter 执行库，因此你可以在每次构建时以编程方式更新文档。例如，请参阅 Jupyter notebooks。

告诫侧边栏#

A sidebar admonition!

我是用 {admonition} 指令和 sidebar 类创建的。

此主题支持一种简便的方式，使 提示框表现得像侧边栏。这是一种在不显著打断垂直阅读流程的情况下，突出显示内容的有用方法。

例如，在右侧是“提示框侧边栏”和传统的 Sphinx 侧边栏。

要让提示框表现得像侧边栏，请在其类列表中添加 sidebar 类。本节中的提示框侧边栏是使用以下 Markdown 创建的：

.. admonition:: A sidebar admonition!
    :class: sidebar note

    Some sidebar content.

```{admonition} A sidebar admonition!
:class: sidebar note
Some sidebar content.
```

脚注#

这里是数字脚注1Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.，另一个（前面有空格）2Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.，命名脚注3Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.，以及符号脚注4Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.。所有这些在渲染后的 HTML 中都会显示为数字，但在源代码中它们分别看起来像 [^1]、[^2]、[^named] 和 [^*]。