def sphinx():
"""Generate sphinx HTML API documents"""
if Project.enhanced_docs:
diagrams()
hack()
if Project.feature_branch is not None:
remove_non_feature_rst_files()
run_sphinx()
def pdf_generate():
"""generate PDF using current python environment"""
global doc_errors
if Project.enhanced_docs:
diagrams()
hack()
with cd(Project.docs_dir):
with open("pdf.log", "w") as outputter:
output = run_python('sphinx-build -b pdf -d _build/doctrees -w docs.log '
'-a -E -n . ../{pdfdir}'.format(pdfdir=Project.docs_pdf_dir),
doc_errors=doc_errors)
outputter.write(output)
clean_doc_log('docs.log')
def sphinx_no_api():
"""Generate sphinx HTML documents (no API)"""
if Project.enhanced_docs:
diagrams()
hack()
run_sphinx()
def sphinx():
"""Generate sphinx HTML API documents"""
if Project.enhanced_docs:
diagrams()
hack()
run_sphinx()