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
|
# -*- encoding: ascii -*-
"""
Doc Tasks
~~~~~~~~~
"""
import os as _os
import invoke as _invoke
from . import compile as _compile
@_invoke.task(_compile.compile)
def userdoc(ctx):
""" Create userdocs """
_sphinx(ctx, ctx.doc.sphinx.build, ctx.doc.sphinx.source, ctx.doc.userdoc)
@_invoke.task(userdoc, default=True)
def doc(ctx): # pylint: disable = unused-argument
""" Create docs """
@_invoke.task()
def website(ctx):
""" Create website """
ctx.shell.rm_rf(ctx.doc.website.source)
ctx.shell.cp_r(ctx.doc.sphinx.source,
_os.path.join(ctx.doc.website.source, 'src'))
ctx.shell.rm_rf(ctx.doc.website.target)
ctx.shell.mkdir_p(ctx.doc.website.target)
dlfile = _os.path.join(ctx.doc.website.source, 'src',
'website_download.txt')
with open(dlfile, 'rb') as fp:
download = fp.read().decode('latin-1')
ixfile = _os.path.join(ctx.doc.website.source, 'src', 'index.txt')
with open(ixfile, 'rb') as fp:
index = fp.read().decode('latin-1').splitlines(True)
with open(ixfile, 'wb') as fp:
for line in index:
if line.startswith('.. placeholder: Download'):
line = download
fp.write(line.encode('latin-1'))
_sphinx(ctx,
ctx.shell.native(_os.path.join(ctx.doc.website.source, 'build')),
ctx.shell.native(_os.path.join(ctx.doc.website.source, 'src')),
ctx.shell.native(ctx.doc.website.target))
ctx.shell.rm(_os.path.join(ctx.doc.website.target, '.buildinfo'))
def _sphinx(ctx, build, source, target):
""" Run sphinx """
sphinx = ctx.shell.frompath('sphinx-build')
if sphinx is None:
raise RuntimeError("sphinx-build not found")
with ctx.shell.root_dir():
ctx.run(ctx.c(r'''
%(sphinx)s -a -d %(doctrees)s -b html %(source)s %(target)s
''', **dict(
sphinx=sphinx,
doctrees=_os.path.join(build, 'doctrees'),
source=source,
target=target,
)), echo=True)
|