Skip to content

Commit 45df43e

Browse files
authored
[Change] remove blank ps (#6294)
1 parent 3117adc commit 45df43e

File tree

1 file changed

+11
-8
lines changed
  • ci_scripts/doc-build-config/en

1 file changed

+11
-8
lines changed

ci_scripts/doc-build-config/en/conf.py

+11-8
Original file line numberDiff line numberDiff line change
@@ -356,14 +356,17 @@ def remove_doctest_directives(app, what, name, obj, options, lines):
356356
"""
357357
Remove `doctest` directives from docstring
358358
"""
359-
pattern_doctest = re.compile(r"\s*>>>\s*#\s*doctest:\s*.*")
360-
361359
# Modify the lines inplace
362-
lines[:] = [
363-
line
364-
for line in lines
365-
if not (pattern_doctest.match(line) or line.strip() == ">>>")
366-
]
360+
# remove doctest directive
361+
pattern_doctest = re.compile(r"\s*>>>\s*#\s*x?doctest:\s*.*")
362+
lines[:] = [line for line in lines if not pattern_doctest.match(line)]
363+
364+
# remove blank ps(`>>>`)
365+
lines[:] = [line for line in lines if not line.strip() == ">>>"]
366+
367+
# make sure there is a blank line at the end
368+
if lines and lines[-1]:
369+
lines.append('')
367370

368371

369372
def setup(app):
@@ -390,5 +393,5 @@ def setup(app):
390393
)
391394
app.add_transform(AutoStructify)
392395

393-
# remove doctest directives
396+
# remove doctest directives and blank ps
394397
app.connect("autodoc-process-docstring", remove_doctest_directives)

0 commit comments

Comments
 (0)