Python 如何在Sphinx文档中显示矩阵?

Python 如何在Sphinx文档中显示矩阵?,python,python-sphinx,Python,Python Sphinx,我有一个矩阵,比如说3x3,我想在生成的Python文档的sphinx文档中显示它 def Matrix_func(): """ [1 4 7 ] M = [2 5 8 ] [3 6 9 ] """ 目前,上述矩阵没有像在生成的sphinx文档中那样打印。以下是如何将矩阵包含在函数docstring中: def Matrix_func(): """ :: [

我有一个矩阵,比如说3x3,我想在生成的Python文档的sphinx文档中显示它

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

目前,上述矩阵没有像在生成的sphinx文档中那样打印。

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

def Matrix_func():
    """
    ::

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

    More text...

    """

请注意双冒号(
),表示a.

或使用MathJax扩展名

在sphinx
config.py中添加

然后,一个漂亮的数组将以以下方式呈现:

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

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


这个答案晚了2.25年,但我希望它能帮助某些人;)

有许多可用的格式化工具和方法。你试过哪些,结果如何?
def Matrix_func():
    r"""
    .. math::

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