我目前正在使用Sphinx文档化我的Python项目。在多行docstring的部分包含一个项目列表时,我遇到了一个问题。
我想包括一个带有项目符号的列表,但其中一个项目非常长。 我希望:
- 列表能够通过Sphinx正确呈现
- 但同时也要遵守PEP8关于行长度(<79)的规定
您会为这个docstring提供什么建议?
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的项目符号列表。