16

我目前正在使用 Sphinx 记录我的 Python 项目。在文档字符串的多行部分中包含项目符号列表时遇到了一个问题。

我想包括一个项目符号列表，但其中一个项目很长。我想：

  • 通过 Sphinx 正确呈现项目符号列表
  • 但也让我的代码尊重 PEP8 关于行长（<79）

你会建议我为这个文档字符串做什么：

class geography():
""" Class defining a geography (cities and distance matrix)

This class implements a geography with a list of named cities with their
associated coordinates in a plane. Helper functions enable to :

- give a visual representation of that geography
- give a visual representation of the distance matrix
- give a visual representation of a configuration, a configuration being the repartition of some or all cities in pools

...

最后一行超过 79 个字符。

然后通过 Sphinx 呈现评论。添加回车符只会破坏 Sphinx 中的项目符号列表。

4

2 回答 2

18

您可以根据需要断开项目符号行。只需将延续与前几行文本对齐，例如：

- give a visual representation of that geography
- give a visual representation of the distance matrix
- give a visual representation of a configuration, a configuration being the
  repartition of some or all cities in pools
于 2019-02-13T19:22:43.817 回答
7

@Stephen Rauch的解决方案是完美的解决方案。我只是想补充一点，它也适用于非项目符号列表。对于函数或方法的参数的注释，我也有类似的问题。例如：

def permute_array(arr, seq):
""" Function to "square permute" a 2D array

This function's purpose is to enable distance matrices permutations. That 
is, for example, permute both lines and columns of the array so as to 
reorder a distance matrix.

Args:
    arr (numpy array): the array to permute. It should be square of size n.
    seq (iterable of int): a permutation of range(n) (should be of length n and contain every integer from 0 to n-1)

最后一行太长了。

但是，“相同的缩进级别”换行符只会破坏漂亮的 sphinx 方法文档：

    Args:
        arr (numpy array): the array to permute. It should be square of size n.
        seq (iterable of int): a permutation of range(n) (should be of length n
        and contain every integer from 0 to n-1)

糟糕的构建文档

但是，用标识打破界限就可以了。

    Args:
        arr (numpy array): the array to permute. It should be square of size n.
        seq (iterable of int): a permutation of range(n) (should be of length n
            and contain every integer from 0 to n-1)

精心构建的文档

于 2019-02-16T11:25:04.640 回答