Skip to content

Make doc compiling under windows workable #5245

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.

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

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
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
26 changes: 25 additions & 1 deletion doc/make.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,35 @@ def clean():


def html():
# Sphinx fails on embedded unicode on Windows, so replace the offending
# strings before the build and restore them afterwards
import os, io
_bad = r" data = 'word,length\nTr\xe4umen,7\nGr\xfc\xdfe,5'"
_good = """ # Due to problems with sphinx and embedded unicode under windows,
# the umlauts were replaced during doc generation!
data = 'word,length\\nTraumen,7\\nGruse,5'"""
if os.name == 'nt':
with io.open("source/io.rst", 'r', encoding='ascii') as f:
io_doc = f.read()
io_doc = io_doc.replace(_bad, _good)
with io.open("source/io.rst", 'w', encoding='ascii') as f:
f.write(io_doc)
check_build()
if os.system('sphinx-build -P -b html -d build/doctrees '
'source build/html'):
raise SystemExit("Building HTML failed.")

if os.name == 'nt':
with io.open("source/io.rst", 'r', encoding='ascii') as f:
io_doc = f.read()
io_doc = io_doc.replace(_good,_bad)
with io.open("source/io.rst", 'w', encoding='ascii') as f:
f.write(io_doc)
# these files are often left over due to "[Error 32] file in use"
try:
os.remove('tmp.sv')
os.remove('store.h5')
except:
pass

def latex():
check_build()
Expand Down