微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

Sphinx 仅包含包含文档字符串的类和函数

如何解决Sphinx 仅包含包含文档字符串的类和函数

我在一个 python 文件中有多个类(准确地说是 sqlalchemy 类)。我正在尝试使用 sphinx 包记录一些类。

我在某些类下放置了一些文档字符串,但最后列出了所有类,包括和不包括文档字符串。

我正在使用 autodoc

Contents:

.. toctree::
   :maxdepth: 3

.. automodule:: blog.models
   :members:

我可以指定要包含哪些类的唯一方法是这样的:

.. automodule:: blog.models
   :members: SomeClass,SomeClass2,..,SomeClass1001

有没有办法只添加带有文档字符串的类、函数

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。