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.

Sign up for GitHub

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

Jump to bottom

Use ruff format #38

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Use ruff format #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 84 additions & 60 deletions docs/pestutilslib/docx_to_md.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
import sys
import os


def processFile(inFile, outFile):
mdFile = open(inFile, 'r')
mdFile = open(inFile, "r")
toc = []
levels = [0,0,0,0,0 ]
newFile = open(outFile, 'w')
levels = [0, 0, 0, 0, 0]
newFile = open(outFile, "w")
tempFile = []
tocLoc = 0
partOfToc = False

for line in mdFile:
if partOfToc and line != '\n':
if partOfToc and line != "\n":
continue
else:
partOfToc = False
if 'Table of Contents' in line:
if "Table of Contents" in line:
tocLoc = len(tempFile) + 1
partOfToc = True
line += "\n"
elif line[0] == '#':
elif line[0] == "#":
secId = buildToc(line, toc, levels)
line = addSectionTag(cleanLine(line), secId) + '\n'
line = addSectionTag(cleanLine(line), secId) + "\n"
tempFile.append(line)


for line in toc:
tempFile.insert(tocLoc, line)
tocLoc += 1
Expand All @@ -36,58 +36,75 @@ def processFile(inFile, outFile):
mdFile.close()
newFile.close()


def addSectionTag(line, secId):
startIndex = line.find(' ')
line = line[:startIndex + 1] + '<a id=\'' + secId + '\' />' + line[startIndex + 1:]
startIndex = line.find(" ")
line = line[: startIndex + 1] + "<a id='" + secId + "' />" + line[startIndex + 1 :]
return line


def buildToc(line, toc, levels):
line = cleanLine(line)
secId = 's'
if line[:4] == '####':

#raise UserWarning('Header levels greater than 3 not supported')
secId = "s"
if line[:4] == "####":
# raise UserWarning('Header levels greater than 3 not supported')
levels[4] += 1
secId += str(levels[1]) + '-' + str(levels[2]) + '-' + str(levels[3]) + '-' + str(levels[4])
toc.append(' - [' + line[5:] + '](#' + secId + ')\n')
elif line[:3] == '###':
secId += (
str(levels[1])
+ "-"
+ str(levels[2])
+ "-"
+ str(levels[3])
+ "-"
+ str(levels[4])
)
toc.append(" - [" + line[5:] + "](#" + secId + ")\n")
elif line[:3] == "###":
levels[3] += 1
secId += str(levels[1]) + '-' + str(levels[2]) + '-' + str(levels[3])
toc.append(' - [' + line[4:] + '](#' + secId + ')\n')
elif line[:2] == '##':
secId += str(levels[1]) + "-" + str(levels[2]) + "-" + str(levels[3])
toc.append(" - [" + line[4:] + "](#" + secId + ")\n")
elif line[:2] == "##":
levels[2] += 1
levels[3] = 0
secId += str(levels[1]) + '-' + str(levels[2])
toc.append(' - [' + line[3:] + '](#' + secId + ')\n')
elif line[:1] == '#':
secId += str(levels[1]) + "-" + str(levels[2])
toc.append(" - [" + line[3:] + "](#" + secId + ")\n")
elif line[:1] == "#":
levels[1] += 1
levels[3] = levels[2] = 0
secId += str(levels[1])
toc.append('- [' + line[2:] + '](#' + secId + ')\n')
toc.append("- [" + line[2:] + "](#" + secId + ")\n")
return secId


def cleanLine(text):
text = stripNewline(text)
text = removeAnchors(text)
return text


def stripNewline(text):
return text.replace('\n', '')
return text.replace("\n", "")


def removeAnchors(text):
while ('<' in text and '>' in text):
leftTag = text.index('<')
rightTag = text.index('>')
text = text[0:leftTag] + text[rightTag + 1:]
while "<" in text and ">" in text:
leftTag = text.index("<")
rightTag = text.index(">")
text = text[0:leftTag] + text[rightTag + 1 :]
return text

def clean(docx_file,inFile,outFile,run_pandoc=True):

def clean(docx_file, inFile, outFile, run_pandoc=True):
if run_pandoc:
os.system("pandoc -t gfm --wrap=none --extract-media . -o file.md {0} --mathjax".format(docx_file))
num_str = [str(i) for i in range(1,11)]
lines = open(inFile,'r').readlines()
os.system(
"pandoc -t gfm --wrap=none --extract-media . -o file.md {0} --mathjax".format(
docx_file
)
)
num_str = [str(i) for i in range(1, 11)]
lines = open(inFile, "r").readlines()

#notoc_lines = []
# notoc_lines = []
i = 0
# while i < len(lines):
# line = lines[i]
Expand All @@ -104,31 +121,40 @@ def clean(docx_file,inFile,outFile,run_pandoc=True):
# notoc_lines = []
i = 0
while i < len(lines):
#if lines[i].strip().startswith("----"):
# if lines[i].strip().startswith("----"):
# lines[i-1] = "## " + lines[i-1]
# lines[i] = "\n"
if "<img" in lines[i]:
lines[i] = lines[i].replace("#","")
lines[i] = lines[i].replace("#", "")
if "<p>" in lines[i]:
lines[i] = lines[i].replace("<p>","").replace("</p>","<br>").replace("#","~")
lines[i] = (
lines[i].replace("<p>", "").replace("</p>", "<br>").replace("#", "~")
)
if "blockquote" in lines[i]:
lines[i] = lines[i].replace("<blockquote>","").replace("</blockquote>","")
lines[i] = lines[i].replace("<blockquote>", "").replace("</blockquote>", "")
if lines[i].strip().startswith("$") and not "bmatrix" in lines[i].lower():
label = lines[i].split()[-1]
eq_str = lines[i].replace("$$","$").split('$')[1]
eq_str = r"{0}".format(eq_str).replace("\\\\","\\").replace(" \\ "," ").replace("\\_","_")
math_str_pre = "<img src=\"https://latex.codecogs.com/svg.latex?\Large&space;{0}".format(eq_str)
math_str_post = "\" title=\"\Large {0}\" /> {1} <br>".format(eq_str,label)
eq_str = lines[i].replace("$$", "$").split("$")[1]
eq_str = (
r"{0}".format(eq_str)
.replace("\\\\", "\\")
.replace(" \\ ", " ")
.replace("\\_", "_")
)
math_str_pre = '<img src="https://latex.codecogs.com/svg.latex?\Large&space;{0}'.format(
eq_str
)
math_str_post = '" title="\Large {0}" /> {1} <br>'.format(eq_str, label)
lines[i] = math_str_pre + " " + math_str_post
if lines[i].strip().startswith("<table>"): # and "pcf" in lines[i].lower():
lines[i] = "<div style=\"text-align: left\">" + lines[i] + "</div>"
if lines[i].strip().startswith("<table>"): # and "pcf" in lines[i].lower():
lines[i] = '<div style="text-align: left">' + lines[i] + "</div>"
if "comment" in lines[i].lower():
lines[i] = lines[i].replace("~","#")
lines[i] = lines[i].replace("~", "#")
elif lines[i].strip().startswith("[") and "]" in lines[i]:
raw = lines[i].strip().split(']')
rraw = " ".join(raw[0].split()[:-1])+"]"
raw = lines[i].strip().split("]")
rraw = " ".join(raw[0].split()[:-1]) + "]"
new_line = rraw + "".join(raw[1:]) + "\n"
print(lines[i],new_line)
print(lines[i], new_line)
lines[i] = new_line
# elif "bmatrix" in lines[i].lower():
# eq_str = lines[i]
Expand All @@ -146,20 +172,18 @@ def clean(docx_file,inFile,outFile,run_pandoc=True):

i += 1

#lines[0] = "# Table of Contents\n"
with open(outFile,'w') as f:

# lines[0] = "# Table of Contents\n"
with open(outFile, "w") as f:
for line in lines:
#if line.lower().strip().startswith("[introduction"):
# if line.lower().strip().startswith("[introduction"):
# f.write("\n# Table of Contents\n\n")
f.write(line)


if __name__ == "__main__":

clean("new_function_documentation.docx","file.md","fortran_library_documentation.md",True)





clean(
"new_function_documentation.docx",
"file.md",
"fortran_library_documentation.md",
True,
)
15 changes: 11 additions & 4 deletions examples/clear_output_all.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
import os

dirs = ["."]
notebook_count = 0
for d in dirs:
nb_files = [os.path.join(d,f) for f in os.listdir(d) if f.lower().endswith(".ipynb")]
nb_files = [
os.path.join(d, f) for f in os.listdir(d) if f.lower().endswith(".ipynb")
]
for nb_file in nb_files:
print("clearing",nb_file)
os.system("jupyter nbconvert --ClearOutputPreprocessor.enabled=True --ClearMetadataPreprocessor.enabled=True --inplace {0}".format(nb_file))
print("clearing", nb_file)
os.system(
"jupyter nbconvert --ClearOutputPreprocessor.enabled=True --ClearMetadataPreprocessor.enabled=True --inplace {0}".format(
nb_file
)
)
notebook_count += 1
print(notebook_count," notebooks cleared")
print(notebook_count, " notebooks cleared")
Loading