Sphinx:如何将代码块放在autodoc中的特定变量描述中?

时间:2016-02-19 13:09:36

标签: python-sphinx autodoc

我想在参数描述中加入几行代码示例。可以添加:param,:type等。但是可以在:param之前添加一个注释块吗? 这是我现在使用的代码:

    :param namespace_type: defines the category of the equation.
    :type namespace_type: str
    :param n_comp: number of compartments in the neuron
    :type n_comp: int
    :param layer_idx: indices of the layers in which neuron resides.
    :type layer_idx: array
    :param eq_template_soma: the template equation used for soma in brian2:
    dgeX/dt = -geX/tau_eX : siemens
    dgealphaX/dt = (geX-gealphaX)/tau_eX : siemens
    dgi/dt = -gi/tau_i : siemens
    dgialpha/dt = (gi-gialpha)/tau_i : siemens
产生this

如您所见,方程式部分(采用brian2模块中使用的格式)显示为未对齐的纯文本。我想把这些方程式作为代码样本。

0 个答案:

没有答案