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

fix: table format when markdown render to html #6568

Merged
merged 1 commit into from
Mar 31, 2024

Conversation

hu-qi
Copy link
Contributor

@hu-qi hu-qi commented Mar 30, 2024

本次修改的文件比较多,原因是排查到 markdown 语法不规范导致表格在渲染到 html 时出现排版错乱,如以下页面:

image
torch.cuda.current_stream

image
torch.normal

经过细致排查,罪魁祸首是模板给的就不对,详见 pytorch_api_mapping_format_cn.md , 尽管在编辑器或者 github 上能正常显示表格,但在某些场景下不会被渲染(参见 Markdown Tables Not Rendering Correctly)。因此,table 前一行最好为空行。

关联 issue: #6449

Copy link

paddle-bot bot commented Mar 30, 2024

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

@hu-qi
Copy link
Contributor Author

hu-qi commented Mar 31, 2024

修改之后的效果立竿见影:

image

image

Copy link
Member

@SigureMo SigureMo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTMeow 🐾

@SigureMo SigureMo merged commit e2327a2 into PaddlePaddle:develop Mar 31, 2024
2 checks passed
@sunzhongkai588 sunzhongkai588 added the HappyOpenSource 快乐开源活动issue与PR label Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor HappyOpenSource 快乐开源活动issue与PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants