summaryrefslogtreecommitdiff
path: root/xnt
diff options
context:
space:
mode:
authorkennyballou <kballou@onyx.boisestate.edu>2013-06-24 17:53:06 -0600
committerkennyballou <kballou@onyx.boisestate.edu>2013-06-24 17:53:06 -0600
commit2f14355ddecdc11cdccef6dfb50b612e6f469cfa (patch)
tree9e4ff05f6a95dff3371103b4bae85f8d18c19ba0 /xnt
parent2633043635ef2e2ce480d937fe79f65a793a2aa4 (diff)
downloadxnt-2f14355ddecdc11cdccef6dfb50b612e6f469cfa.tar.gz
xnt-2f14355ddecdc11cdccef6dfb50b612e6f469cfa.tar.xz
Update build reference documentation
* use sphinx `autofunction` to include the relevant functions / sections into the build reference page * Merge and update notes about the build modules
Diffstat (limited to 'xnt')
-rw-r--r--xnt/build/make.py12
-rw-r--r--xnt/build/tex.py3
2 files changed, 15 insertions, 0 deletions
diff --git a/xnt/build/make.py b/xnt/build/make.py
index 28c17b0..9319d05 100644
--- a/xnt/build/make.py
+++ b/xnt/build/make.py
@@ -24,6 +24,10 @@ from xnt.tasks import which
def ant(target, path="", flags=None, pkeys=None, pvalues=None):
"""Wrapper around Apache Ant
+ Invoke Apache Ant in either the current working directory or the specified
+ directory using the specified target, passing a list of *flags* to the
+ invocation. Where *flags* is a list of valid flags for *ant*.
+
`pkeys` and `pvalues` are zipped to form a key/value pair passed to Ant as
property values
@@ -44,6 +48,10 @@ def ant(target, path="", flags=None, pkeys=None, pvalues=None):
def make(target, path="", flags=None, pkeys=None, pvalues=None):
"""Wrapper around GNU Make
+ Invoke Gnu Make (*make*) in either the current working directory or the
+ specified directory using the specified target, passing a list of *flags*
+ to the invocation. Where *flags* is a list of valid flags for *make*.
+
`pkeys` and `pvalues` are zipped together to form a key/value pair that are
passed to Make as property values.
@@ -62,6 +70,10 @@ def make(target, path="", flags=None, pkeys=None, pvalues=None):
def nant(target, path="", flags=None, pkeys=None, pvalues=None):
"""Wrapper around .NET Ant
+ Invoke NAnt in either the current working directory or the specified
+ directory using the specified target, passing a list of *flags* to the
+ invocation. Where *flags* is a list of valid flags for *nant*.
+
`pkeys` and `pvalues` are zipped together to form a key/ value pair to pass
to NAnt as property values.
diff --git a/xnt/build/tex.py b/xnt/build/tex.py
index f5e6396..5ff5e3e 100644
--- a/xnt/build/tex.py
+++ b/xnt/build/tex.py
@@ -30,6 +30,9 @@ def pdflatex(document,
makeglossary=False):
"""Generate PDF LaTeX Document
+ Use `pdflatex` to build a LaTeX PDF document. Can optionally execute steps
+ to properly build `bibtex` references and/ or glossaries.
+
:param document: Name of tex file (with or without `.tex` extension)
:param path: Directory of tex file, if different than current directory
:param bibtex: Flag to or not to add bibtex. Default: False