1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
|
import argparse
import os
import re
import basix
from markdown import markdown as _markdown
_path = os.path.dirname(os.path.realpath(__file__))
def path(dir):
return os.path.join(_path, dir)
temp = path("_temp")
parser = argparse.ArgumentParser(description="Build Basix documentation")
parser.add_argument('--url', metavar='url',
default="http://localhost", help="URL of built documentation")
parser.add_argument('--clone', metavar='clone',
default="true", help="Clone the web repository")
args = parser.parse_args()
url = args.url
url_no_http = url.split("//")[1]
def markdown(txt):
"""Convert markdown to HTML."""
# Convert code inside ```s (as these are not handled by the markdown library
tsp = txt.split("```")
out = ""
code = False
for part in tsp:
if code:
part = part.strip().split("\n")
if part[0] in ["console", "bash", "python", "c", "cpp"]:
part = part[1:]
part = "\n".join(part)
out += f"<pre><code>{part}</code></pre>"
else:
out += part
code = not code
return _markdown(out)
def unicode_to_html(txt):
txt = txt.replace("\xe9", "é")
return txt
def make_html_page(html):
with open(os.path.join(temp, "intro.html")) as f:
pre = f.read()
with open(os.path.join(temp, "outro.html")) as f:
post = f.read()
return pre + html + post
def link_markup(matches):
return f"[{url_no_http}/{matches[1]}]({url}/{matches[1]})"
def insert_info(txt):
if "{{SUMMARY}}" in txt:
started = False
info = ""
with open(path("../../README.md")) as f:
for line in f:
if not started and line.strip() != "" and line[0] not in ["!", "#"]:
started = True
if started:
if line.startswith("#"):
break
info += line
info = info.replace("joss/img", "img")
txt = txt.replace("{{SUMMARY}}", info)
if "{{SUPPORTED ELEMENTS}}" in txt:
with open(path("../../README.md")) as f:
info = "## Supported elements" + f.read().split("## Supported elements")[1].split("\n## ")[0]
info = info.replace("joss/img", "img")
txt = txt.replace("{{SUPPORTED ELEMENTS}}", info)
if "{{INSTALL}}" in txt:
with open(path("../../INSTALL.md")) as f:
info = f.read()
txt = txt.replace("{{INSTALL}}", info)
txt = txt.replace("{{URL}}", url)
txt = txt.replace("{{VERSION}}", basix.__version__)
txt = re.sub(r"\{\{link:URL/([^\}]*)\}\}", link_markup, txt)
return txt
def system(command):
assert os.system(command) == 0
# Make paths
for dir in ["html", "cpp", "python"]:
if os.path.isdir(path(dir)):
system(f"rm -r {path(dir)}")
if os.path.isdir(temp):
system(f"rm -r {temp}")
system(f"mkdir {path('html')}")
system(f"mkdir {temp}")
# Copy cpp and python folders
system(f"cp -r {path('../cpp')} {path('cpp')}")
system(f"cp -r {path('../python')} {path('python')}")
system(f"mkdir {path('python/source/_templates')}")
# Prepare templates
if args.clone == "true":
if os.path.isdir(path('web')):
system(f"rm -r {path('web')}")
system(f"git clone http://github.com/FEniCS/web {path('web')}")
with open(f"{path('web')}/template.md", "w") as f:
f.write("---\n")
f.write(insert_info("title: \"Basix {{VERSION}}\"\n"))
f.write("---\n")
f.write("\n")
f.write("!!CONTENT!!\n")
system(f"cd {path('web')} && bundle install && bundle exec jekyll build")
with open(f"{path('web')}/_site/template.html") as f:
template = f.read()
template = template.replace("<p>!!", "!!")
template = template.replace("!!</p>", "!!")
template = template.replace("=\"/", "=\"https://fenicsproject.org/")
template = template.replace("(/assets", "(https://fenicsproject.org/assets")
template = template.replace(
"/assets/css/customsty.css\">",
"/assets/css/customsty.css\">\n"
" <link rel=\"stylesheet\" type=\"text/css\" href=\"/assets/sty.css\">")
intro, outro = template.split("!!CONTENT!!")
with open(path("template/navbar.html")) as f:
intro += f"<h2 id=\"project_subtitle\">{insert_info(f.read())}</h2>"
with open(os.path.join(temp, "intro.html"), "w") as f:
f.write(intro)
with open(os.path.join(temp, "outro.html"), "w") as f:
f.write(outro)
with open(path("cpp/footer.html"), "w") as f:
f.write(outro)
with open(path("cpp/header.html"), "w") as f:
f.write(intro.split("<!-- Begin Jekyll SEO tag")[0])
with open(path("cpp-seo.html")) as f2:
f.write(insert_info(f2.read()))
f.write(intro.split("<!-- End Jekyll SEO tag -->")[1])
with open(path("cpp-header.html")) as f2:
f.write(insert_info(f2.read()))
content = "{% extends \"!layout.html\" %}\n"
content += "{%- block content %}\n"
content += intro.split("<body>")[1] + "\n"
content += " {{ super() }}\n"
content += outro.split("</body>")[0] + "\n"
content += "{% endblock %}\n"
content += "{%- block extrahead %}\n"
content += intro.split("<head>")[1].split("</head>")[0] + "\n"
content += " {{ super() }}\n"
content += "{% endblock %}"
with open(path("python/source/_templates/layout.html"), "w") as f:
f.write(insert_info(content))
with open(path("cpp/Doxyfile")) as f:
content = ""
for line in f:
if line.startswith("HTML_HEADER"):
content += f"{line.split('=')[0]}= header.html\n"
elif line.startswith("HTML_FOOTER"):
content += f"{line.split('=')[0]}= footer.html\n"
else:
content += line.replace(" ..", " ../..")
with open(path("cpp/Doxyfile"), "w") as f:
f.write(content)
# Copy images and assets
system(f"cp -r {path('../../joss/img')} {path('html')}/img")
system(f"cp -r {path('assets')} {path('html')}/assets")
# Convert markdown to html
for file in os.listdir(_path):
if file.endswith(".md"):
with open(path(file)) as f:
contents = unicode_to_html(insert_info(f.read()))
with open(os.path.join(path('html'), file[:-3] + ".html"), "w") as f:
f.write(make_html_page(markdown(contents)))
# Make cpp docs
system(f"cd {path('cpp')} && doxygen")
system(f"cp -r {path('cpp/html')} {path('html/cpp')}")
# Make demos
os.system(f"rm {path('../../demo/python/*.py.rst')}")
os.system(f"rm {path('../../demo/python/*.png')}")
# If file saves matplotlib images, run the demo
for file in os.listdir(path("../../demo/python")):
if file.endswith(".py"):
with open(path(f"../../demo/python/{file}")) as f:
content = f.read()
if "savefig" in content:
here = os.getcwd()
os.chdir(path("../../demo/python"))
system(f"python3 {file}")
os.chdir(here)
system(f"cd {path('../../demo/python')} && python3 convert_to_rst.py")
system(f"mkdir {path('python/source/demo')}")
system(f"cp {path('../../demo/python/*.rst')} {path('python/source/demo')}")
system(f"cp {path('../../demo/python/*.png')} {path('python/source/demo')}")
for file in os.listdir(path("python/source/demo")):
if file.endswith(".py.rst"):
with open(path(f"python/source/demo/{file}")) as f:
content = f.read()
content = content.replace("literalinclude:: ../", "literalinclude:: ../../../../../demo/")
with open(path(f"python/source/demo/{file}"), "w") as f:
f.write(content)
with open(path("python/source/index.rst"), "a") as f:
f.write("\n")
f.write(".. toctree::\n")
f.write(" demo/index")
# Make python docs
system(f"cd {path('python')} && python3 -m sphinx -W -b html source/ build/html && rm -rf build/html/.doctrees")
system(f"cp -r {path('python/build/html')} {path('html/python')}")
|