Python Sphinx生成文档中的类路径

我想将一些类公开给包的

\uuuu init\uuuu.py

（为了方便用户），但我想将其实现保留在子包中。 Sphinx正确地从

\uuuuu init\uuuu

生成文档作为元素，但在记录继承类时，它会显示原始文件，而不是

\uuuuu init\uuu

。如果有办法改变它

工作原理：

我不会：

MWE：

\uuuu init\uuuuu.py

from.base\u类导入A
__全部（A）

base_class.py

A类：
def测试（自我）：
通过

inherit_class.py

from.base\u类导入A
B（A）类：
def测试2（自我）：
通过

包装：rst

package package
===============

Submodules
----------

package.inherit\_class module
-----------------------------

.. automodule:: package.inherit_class
   :members:
   :undoc-members:
   :show-inheritance:


Module contents
---------------

.. automodule:: package
   :members:
   :undoc-members:
   :show-inheritance:

index.rst

package
=======

.. toctree::
   :maxdepth: 4

   package

conf.py

Sphinx文档生成器的配置文件。 # #此文件仅包含最常用选项的选择。整整 #列表见文档： # http://www.sphinx-doc.org/en/master/config #--路径设置-------------------------------------------------------------- #如果扩展（或使用autodoc编写文档的模块）位于另一个目录中， #在此处将这些目录添加到sys.path。如果目录是相对于 #文档根目录下，使用os.path.abspath将其设置为绝对值，如下所示。 # 导入操作系统 导入系统 sys.path.insert（0，os.path.abspath（'..'）） #--项目信息----------------------------------------------------- 项目='测试' 版权='2019，Grzegorz Bokota' 作者='Grzegorz Bokota' #完整版本，包括alpha/beta/rc标签 release='0.1' #--一般配置--------------------------------------------------- #在此处添加任何Sphinx扩展模块名称（作为字符串）。他们可能是 #Sphinx（名为“Sphinx.ext.*）或您的自定义 #一个。 extensions=[“sphinx.ext.autodoc” ] #在此添加任何包含模板的路径（相对于此目录）。 模板路径=[''模板'] #模式列表，相对于源目录，匹配文件和 #查找源文件时要忽略的目录。 #此模式还影响html_静态路径和html_额外路径。 排除_模式=[''构建''Thumbs.db'，'.DS_存储'] #--HTML输出选项------------------------------------------------- #用于HTML和HTML帮助页的主题。有关详细信息，请参阅文档 #内置主题的列表。 # html_主题=‘雪花石膏’ #在此处添加包含自定义静态文件（如样式表）的任何路径， #相对于此目录。它们是在内置静态文件之后复制的， #因此，名为“default.css”的文件将覆盖内置的“default.css”。 html_static_path=[''静态'] master_doc=“索引”

---

这看起来类似于。请尝试在base\u class.py中添加

A.。\uuuu module=“package”

。谢谢。你的建议。此响应和此类代码：

python if os.path.basename（sys.argv[0]）in[“sphinx build”，“sphinx build.exe”]：for el in uuu all_u;：globals（）。请尝试在base\u class.py中添加
A.。\uuuu module=“package”
。谢谢。你的建议。这个响应和这样的代码：
python如果[“sphinx build”，“sphinx build.exe”]中的os.path.basename（sys.argv[0]）：对于el-in-all\uuuuuuuuu:globals（）
package
=======

.. toctree::
   :maxdepth: 4

   package