Add initial docs sub-folder

3 files changed, 412 insertions, 0 deletions

diff --git a/docs/source/buildfile.rst b/docs/source/buildfile.rst
new file mode 100644
index 0000000..0fab071
--- /dev/null
+++ b/docs/source/buildfile.rst
@@ -0,0 +1,70 @@
+First Build File
+================
+
+Hello World Example
+-------------------
+
+Writing your first ``build.py`` file is actually quite simple. It's just
+Python!::
+
+    #!/usr/bin/env python
+
+    def helloworld():
+        print("Hello World")
+
+Running this, we should see something similar to::
+
+    $ xnt helloworld
+    Hello World
+
+Adding Xnt to the Mix
+---------------------
+
+Let's start to add some of the features provided by Xnt::
+
+    #!/usr/bin/env python
+
+    from xnt import target #For describing targets
+    import xnt.tasks       #For built-in tasks
+
+    @target
+    def init():
+        """
+        Initialize Project Build Directories
+        """
+        xnt.tasks.mkdir("build")
+
+That may be a lot to take in initially. Let's step through it.
+
+In the first section::
+
+    #!/usr/bin/env python
+
+    from xnt import target #For describing targets
+    import xnt.tasks       #For built-in tasks
+
+If you're familiar with Python, you will notice there is nothing special
+happening with this file yet. We are simply defining the file as a Python file,
+including the ``target`` attribute from the ``xnt`` module, and importing the
+``xnt.tasks`` module.
+
+Next, we will look at a new target::
+
+    @target
+    def init():
+        """
+        Initialize Project Build Directories
+        """
+        xnt.tasks.mkdir("build")
+
+This is a standard definition of a Python function with a decorator.
+
+First, the ``target`` decorator marks the function definition as a target (to
+be used by the ``help`` command, see [make reference]). Next, we define the
+function; this function name *is* the name target. That is, the name given to
+the function will be name given to the command to invoke this target. Further,
+we have the docstring; (this is also used by the ``help`` command) the
+docstring provides a quick description of the purpose of the target, or what
+the target accomplishes when ran. Finally, we call ``mkdir`` of the
+``xnt.tasks`` module. This function, if not obvious by the name, creates a
+directory named 'build' (see [make reference]).
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..920e8cb
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,243 @@
+# -*- coding: utf-8 -*-
+#
+# Xnt documentation build configuration file, created by
+# sphinx-quickstart2 on Mon Oct 29 17:52:47 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../../xnt'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Xnt'
+copyright = u'2012, Kenny Ballou'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.2.3'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Xntdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'Xnt.tex', u'Xnt Documentation',
+   u'Kenny Ballou', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'xnt', u'Xnt Documentation',
+     [u'Kenny Ballou'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'Xnt', u'Xnt Documentation',
+   u'Kenny Ballou', 'Xnt', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..7ecb319
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,99 @@
+.. Xnt documentation master file, created by
+   sphinx-quickstart2 on Mon Oct 29 17:52:47 2012.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Xnt's documentation!
+===============================
+
+Xnt is a high-level wrapper build tool for better managing your projects' build
+process. It allows you to include multiple sub-build tools (such as: ``make``,
+``ant``, ``nant`` and potentially more) in a single project while exposing a
+single and simple interface.
+
+Why you should use Xnt:
+
+- Xnt exposes a single and simple interface for building your project
+
+- Xnt is written in Python, making it easy to expand and extend your build
+  targets
+
+- Your build targets will be described in Python, making it much easier and
+  quicker to write build files for new and existing projects
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   buildfile
+
+Motivation
+==========
+
+When writing something such as a build tool, there is always the question:
+"why?". Why write yet another build tool?
+
+Well, there are several reasons that are the backing motivation:
+
+First, developing a variety of software, using one and only one build tool for
+every project is nearly (if not entirely) impossible. There is a desire to have
+a consistent build step and process when testing and deploying. Given the
+environment in which the code is written is heterogeneous, having one uniform
+build tool that wraps itself around the other ones (and has the ability to
+expand to new ones) is ideal.
+
+Second, short of dropping into the language the build tool was written in,
+expanding some build steps is very difficult (or at least can be). Further
+there can be complicated build targets that require some interesting and
+potentially involved (smelly) procedures to be accomplished, that may or may
+not be easy to describe in the build file or in the native language. Therefore,
+having a wrapping build framework/ tool that is written in an easy to read and
+write language, such as Python, these complicated steps can depend less on some
+funky new build library (further adding to the dependency tree) and can become
+just implementation details (assuming, of course, you buy into Xnt first).
+
+Last, and most certainly the least, I wanted to explore the idea. I wanted to
+write something that made me think about solving some of the problems
+challenged by such a tool.
+
+Installing
+==========
+
+To install, you can either install from source or use Pip.
+
+Source
+------
+
+To install from Source (stable), run the following::
+
+    curl -0 http://pypi.python.org/packages/source/X/Xnt/Xnt-0.2.3.tar.gz \
+    > Xnt.tar.gz
+    tar -xzvf Xnt.tar.gz
+    cd Xnt-0.2.3
+    python setup.py install --user
+
+Development Build
+-----------------
+
+To build and install from a development build(non-stable/ testing), run::
+
+    curl -0 https://bitbucket.org/devnulltao/xnt/get/default.tar.gz \
+    > Xnt.tar.gz
+    tar -xzvf Xnt.tar.gz
+    cd default
+    python setup.py install --user
+
+Pip
+---
+
+To install using Pip, run::
+
+    pip install Xnt --user
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`