API 文档中的一些类型（包括 typehint）依旧显示完整路径

MegEngine / Documentation

MegEngine Official Documentation

https://megengine.org.cn/doc/stable/zh/

Creative Commons Attribution Share Alike 4.0 International

39 stars 59 forks source link

Closed cheekyshibe closed 3 years ago

cheekyshibe commented 3 years ago

比如我们暴露给用户这样一个 Class:

megengine.module.Module

它的实际实现在：

megengine.module.module.Module

一些继承 Module 的 Class 如 Sequential 在显示基类时会显示成后者，而不是我们希望暴露给用户的形式。

这个问题目前不打算从下游进行解决，而是交给 Sphinx 的 autodoc 和 autosummary 进行改进。

Refs:

cheekyshibe commented 3 years ago

已经在 Sphinx 4.0 解决，但目前文档的设置中选择不显示基类。