[Change] remove doctest directives from sphinx conf #6072
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-6072.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
|
这个是没有触发中文文档的编译？！？！？！ |
我刚刚在看中文的，原来英文是没问题的嘛？ 这是中文 repo，为啥会不触发中文的呢，很奇怪 |
|
我大概知道了，autodoc 是用来从英文文档（docstring）自动生成 rst 的 extension，这个 API 应该仅仅针对 docstring 有效，对于中文文档，COPY FROM 应该是插入到 rst 里，它不是 autodoc 生成的，这个 API 不会影响它…… 所以有一种方案，就是在 COPY FROM 时候预处理一下这个代码，只是看起来有点不协调，两者使用了不同的处理方式，但应该能用 |
|
打了个补丁 ... ... 收工 ～ |
SigureMo
reviewed
Jul 28, 2023
| """ | ||
| Remove `doctest` directives from docstring | ||
| """ | ||
| import re |
There was a problem hiding this comment.
按照 python 的规范，import 如非必要放在文件开头吧
| @@ -375,6 +375,18 @@ def linkcode_resolve(domain, info): | |||
| return None | |||
|
|
|||
|
|
|||
| def remove_doctest_directives(app, what, name, obj, options, lines): | |||
@megemini 坏了顺师傅，现在是中文没空行，但英文有空行，以 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR types
Others
PR changes
Others
Description
去掉文档中示例代码的
>>> # doctest: XXX相关行