如何在Sphinx文档中显示Matrix？

Question

我有一个Matrix说3 x 3，我想在Python docs的Generated sphinx文档中显示它。

def Matrix_func():
    """
            [1  4  7 ]
    M   =   [2  5  8 ] 
            [3  6  9 ]
    """

目前，上面的矩阵不会像生成的sphinx文档那样打印。

Answer 1

或使用MathJax扩展

在您的狮身人面像config.py中添加mathjax extension

extensions = [
    # ... other extensions
    'sphinx.ext.mathjax',
]

然后一个漂亮的数组将呈现：

def Matrix_func():
    r"""
    .. math::

        M = \begin{bmatrix}
                1 & 4 & 7 \\
                2 & 5 & 8 \\
                3 & 6 & 9
            \end{bmatrix}
    """

这个答案迟了2.25年，但我希望它对某人有帮助;）

Answer 2

以下是如何在函数docstring中包含矩阵：

def Matrix_func():
    """
    ::

             [1  4  7 ]
       M  =  [2  5  8 ] 
             [3  6  9 ]

    More text...

    """

请注意双冒号（::），表示literal block。