ReadTheDocs功能测试

作者:wallace-lai
发布:2023-11-22
更新:2023-11-30

1. sphinxcontrib-mermaid

1.1 sequence diagram

sequenceDiagram participant Alice participant Bob Alice->John: Hello John, how are you? loop Healthcheck John->John: Fight against hypochondria end Note right of John: Rational thoughts <br/>prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good!

2. mathjax

2.1 One Line

\(a^2 + b^2 = c^2\)

2.2 MultiLine

Maxwell’s Equations :

\[\begin{split} \begin{aligned} \nabla \cdot D &= \beta \\ \nabla \cdot B &= 0 \\ \nabla \times E &= - \frac{\partial B}{\partial t} \\ \nabla \times H &= J + \frac{\partial D}{\partial t} \end{aligned} \end{split}\]

3. myst-parser

3.1 tasklist

  • Step 1

  • Step 2

  • Step 3

4. sphinx-design

4.1 下拉列表

(1)不带标题的下拉列表

下拉列表内容

(2)带标题的下拉列表

下拉列表标题

下拉列表内容

(3)默认打开的下拉列表

默认打开的下拉列表

下拉列表内容

4.2 卡片

5. sphinx-version-warning

源码:

<div id="{id_div0}" class="admonition {note}">
  <p class="first admonition-title">注意</p>
  <p class="last">
    注意事项内容
  </p>
</div>

显示效果:

注意事项

注意事项内容