opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-26 21:07:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #15196 from edsantiago/sphinx_comments

Browse Source 
markdown-preprocess: force extra newline on comments
This commit is contained in:
openshift-ci[bot]
2022-08-05 06:59:41 +00:00
committed by GitHub
parent 49ee311950 5ea4ebb163
commit 253f283220
1 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
hack/markdown-preprocess
View File

@ -46,21 +46,19 @@ def process(infile):
if line.startswith('@@option '):
_, optionname = line.strip().split(" ")
optionfile = os.path.join("options", optionname + '.md')
fh_out.write("[//]: # (BEGIN included file " + optionfile + ")\n")
# Comment intended to help someone viewing the .md file.
# Leading newline is important because if two lines are
# consecutive without a break, sphinx (but not go-md2man)
# treats them as one line and will unwantedly render the
# comment in its output.
fh_out.write("\n[//]: # (BEGIN included file " + optionfile + ")\n")
with open(optionfile, 'r') as fh_optfile:
for opt_line in fh_optfile:
opt_line = opt_line.replace('<POD-OR-CONTAINER>', pod_or_container)
opt_line = opt_line.replace('<SUBCOMMAND>', subcommand)
fh_out.write(opt_line)
# Weird special case: options/image-volume.md ends in a
# list, and in markdown lists are continued across lines,
# so without an intervening blank line the '[//]' comment
# becomes part of the final list entry.
if opt_line.startswith('-'):
fh_out.write("\n")
fh_out.write("[//]: # (END included file " + optionfile + ")\n")
fh_out.write("\n[//]: # (END included file " + optionfile + ")\n")
else:
fh_out.write(line)