logo标签列表

如何在Sphinx文档中显示矩阵？

pythonpython-sphinx
7
我有一个矩阵，比如说是3x3的，我想在生成的Python文档的Sphinx文档中显示它。
def Matrix_func():
    """
            [1  4  7 ]
    M   =   [2  5  8 ] 
            [3  6  9 ]
    """

目前上面的矩阵没有像生成的sphinx文档中那样打印出来。

有很多格式化工具和方法可供选择。您尝试过哪些，结果如何？ - TigerhawkT3
2个回答
11

或者使用MathJax扩展

在您的Sphinxconfig.py中添加mathjax扩展

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年，但我希望它能帮到一些人;)


（注：该内容翻译为中文）
3
以下是如何在函数文档字符串中包含矩阵的方法：
def Matrix_func():
    """
    ::

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

    More text...

    """

请注意双冒号（::），表示文字块。
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接