Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API 文档中的一些类型(包括 typehint)依旧显示完整路径 #71

Closed
ChaiByte opened this issue Apr 8, 2021 · 1 comment
Labels
enhancement New feature or request wontfix This will not be worked on

Comments

@ChaiByte
Copy link
Contributor

ChaiByte commented Apr 8, 2021

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

megengine.module.Module

它的实际实现在:

megengine.module.module.Module

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

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

Refs:

@ChaiByte ChaiByte added enhancement New feature or request wontfix This will not be worked on labels Apr 8, 2021
@ChaiByte
Copy link
Contributor Author

ChaiByte commented Jun 8, 2021

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

@ChaiByte ChaiByte closed this as completed Jun 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant