python - 如何将 Sphinx 的 Autodoc 扩展用于私有(private)方法?

标签 python python-sphinx autodoc

我正在使用 Sphinx 来记录我的 python 项目。我启用了 autodoc 扩展,并且在我的文档中有以下内容。

.. autoclass:: ClassName
   :members:

问题是,它只记录了类中的非私有(private)方法。我如何也包含私有(private)方法?

最佳答案

如果您使用的是 sphinx 1.1 或更高版本,请访问 sphinx 文档站点 http://www.sphinx-doc.org/en/master/ext/autodoc.html ,

:special-members:
:private-members:

关于python - 如何将 Sphinx 的 Autodoc 扩展用于私有(private)方法?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/1149280/

相关文章:

python - sphinx-build 安装在 Mac OS-X 中的哪里?

python - 检查日期列表是否在日期范围列表之间

python - 将返回的字符串转换为字典?

python - 带有 PhysUtil 程序的 GlowScript 未运行

python - pip 和操作系统之间的软件包版本差异?

python - 无法以我想要的格式在 reStructuredtext (Sphinx/readthedocs) 中制作项目符号列表?

python - 从 epydoc 的文档字符串格式切换到 sphinx 文档字符串格式的自动方式?

python-sphinx - 使用 Sphinx 的 Autodoc 仅显示私有(private)方法

ios - 如何使用 Apple Header doc 为 iOS 开发自动生成文档?

python - sphinx 卡在阅读源上... [100%] 索引