PaddlePaddle / docs

Documentations for PaddlePaddle
https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html
Apache License 2.0
240 stars 724 forks source link

[Typing][Fix] 使英文文档中 API 不显示 `type hints` #6847

Closed megemini closed 2 months ago

megemini commented 2 months ago

PR Category

User Experience

PR Types

Bug fixes

Description

使英文文档中 API 签名不显示 type hints

之前的 PR https://github.com/PaddlePaddle/docs/pull/6676 中设置 sphinx 不在接口签名中显示 type hints

image

但,不知道这段时间有什么地方引入了 BUG ,使之前的设置不生效了 ... ...

目前 (20240826 )接口的英文文档

image

特此,重新设置 autodoc_typehints = "none" ,看一下是否生效 ~

@sunzhongkai588 @SigureMo

paddle-bot[bot] commented 2 months ago

感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-6847.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html 预览工具的更多说明,请参考:飞桨文档预览工具

megemini commented 2 months ago

Update 20240826 设置为 none

image image

megemini commented 2 months ago

Update 20240826 设置为 description

恢复原来的默认值,英文页面显示正常 ~ 难道是官网显示有问题???

image

image

megemini commented 2 months ago

Update 20240828

image