python - 如何为 Sphinx 自定义模块名称

Question

就 Sphinx 而言，我是新手。我的项目结构如下:

• argparse_actions/
  • argparse_actions/
    • __初始化__.py
    • folder_actions.py
    • ip_actions.py
  • 文档/
    • _build/
    • index.rst ==> 这是起点、主页或根文档。
    • 还有更多...

__init__.py 看起来像这样:

from folder_actions import *
from ip_actions import *

folder_actions.py 看起来像这样:

'''
Folder Actions
==============

This module implements some reusable custom actions.

.. autoclass:: FolderExistsAction
.. autoclass:: FolderCreateAction
   :members:

'''

# The rest of the code

生成的 HTML 文档看起来很好，除了这部分:

类 folder_actions.FolderCreateAction( ... )

我知道 folder_actions 模块前缀是正确的，但我想将其改为使用包名称，如下所示:

类 argparse_actions.FolderCreateAction( ... )

我有办法实现这个目标吗？

更新

• 根文档在 doc/index.rst

• 如果我将文档字符串从 folder_actions.py 移动到 __init__.py，那么文档将如下所示:

  class __init__.FolderCreateAction( ... )
  

• 仅供引用，我的项目现在在 BitBucket 上

更新2

我不知道为什么我的更改没有推送到 BitBucket，但这无关紧要。请查看同一项目，推送至GitHub .感谢你的帮助，mzjn。

Answer 1

经过几个月的中断，我终于找到了解决方案:将以下行添加到 folder_actions.py 和 ip_action.py 模块的文档字符串中:

.. module:: argparse_actions

最好，这一行应该是模块文档字符串的第一行。