forked from fabric/fabric
/
docs.py
42 lines (33 loc) · 841 Bytes
/
docs.py
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
from __future__ import with_statement
from fabric.api import *
from fabric.contrib.project import rsync_project
from fabric.version import get_version
docs_host = 'jforcier@fabfile.org'
@task(default=True)
def build(clean='no', browse_='no'):
"""
Generate the Sphinx documentation.
"""
c = ""
if clean.lower() in ['yes', 'y']:
c = "clean "
b = ""
with lcd('docs'):
local('make %shtml%s' % (c, b))
if browse_.lower() in ['yes', 'y']:
browse()
@task
def browse():
"""
Open the current dev docs in a browser tab.
"""
local("open docs/_build/html/index.html")
@task
@hosts(docs_host)
def push():
"""
Build docs and zip for upload to RTD
"""
build(clean='yes')
v = get_version('short')
local("cd docs/_build/html && zip -r ../%s.zip ." % v)