我最近开始为我的项目添加文档,并尝试遵循Google风格指南。我正在使用Sphinx生成文档,并使用Sphinx扩展napoleon来弥补Google风格指南和reST之间的差距。
我可以轻松地呈现params和Notes,但是似乎无法使示例部分呈现代码片段。
class Chicken(object):
"""Animal that lays egg and has feathers
Note:
Chickens love to eat feed
Example:
chicken.eats(feed)
"""
我也尝试过在示例部分使用双冒号。
Example::