
Previously, FIRLangRef.md was incorrectly formatted. This was due to how FIRLangRef.md had no page header, and so the first entry would render incorrectly. This patch introduces a header file, which is prepended to the FIRLangRef before it becomes a HTML file. The header is currently brief but can be expanded upon at a later date if required. This formatting fix also means the index page can correctly generate a link to FIRLangRef.html and as such, this patch also removes FIRLangRef from the sidebar and adds it to the main list of links. Depends on D128650 Reviewed By: kiranchandramohan Differential Revision: https://reviews.llvm.org/D129186
19 lines
858 B
Python
19 lines
858 B
Python
# This script combines FIRLangRef_Header.md with the auto-generated Dialect/FIRLangRef.md
|
|
# for the purpose of creating an introduction header/paragraph for FIRLangRef.html
|
|
|
|
# These paths are relative from the build directroy, not source, as that's where this tool is exectued.
|
|
header_path = 'Source/FIR/FIRLangRef_Header.md'
|
|
docs_path = 'Dialect/FIRLangRef.md'
|
|
output_path = 'Source/FIRLangRef.md'
|
|
|
|
# 1. Writes line 1 from docs to output, (comment line that the file is autogenerated)
|
|
# 2. Adds a new line
|
|
# 3. Writes the entire header to the output file
|
|
# 4. Writes the remainder of docs to the output file
|
|
with open(output_path, 'w') as output:
|
|
with open(header_path, 'r') as header, open(docs_path, 'r') as docs:
|
|
output.write(docs.readline())
|
|
output.write("\n")
|
|
output.write(header.read())
|
|
output.write(docs.read())
|