Skip to content

Commit

Permalink
Add new release task w/ API doc prebuilding
Browse files Browse the repository at this point in the history
  • Loading branch information
bitprophet committed Mar 4, 2014
1 parent d97d28e commit c05b065
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions tasks.py
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
from os.path import join
from shutil import rmtree, move

from invoke import Collection, ctask as task
from invocations import docs as _docs
from invocations.packaging import publish


d = 'sites'

# Usage doc/API site (published as docs.paramiko.org)
path = join(d, 'docs')
docs_path = join(d, 'docs')
docs_build = join(docs_path, '_build')
docs = Collection.from_module(_docs, name='docs', config={
'sphinx.source': path,
'sphinx.target': join(path, '_build'),
'sphinx.source': docs_path,
'sphinx.target': docs_build,
})

# Main/about/changelog site ((www.)?paramiko.org)
path = join(d, 'www')
www_path = join(d, 'www')
www = Collection.from_module(_docs, name='www', config={
'sphinx.source': path,
'sphinx.target': join(path, '_build'),
'sphinx.source': www_path,
'sphinx.target': join(www_path, '_build'),
})


Expand All @@ -31,4 +34,14 @@ def coverage(ctx):
ctx.run("coverage run --source=paramiko test.py --verbose")


ns = Collection(test, coverage, docs=docs, www=www)
# Until we stop bundling docs w/ releases. Need to discover use cases first.
@task('docs') # Will invoke the API doc site build
def release(ctx):
# Move the built docs into where Epydocs used to live
rmtree('docs')
move(docs_build, 'docs')
# Publish
publish(ctx)


ns = Collection(test, coverage, release, docs=docs, www=www)

0 comments on commit c05b065

Please sign in to comment.