Update readme and start adding sphinx docs.

.gitignore

@@ -1,4 +1,6 @@
 vendor
 main
 dist
-examples/output.*
+examples/output.*
+docs/_build
+.DS_Store

README.md

@@ -3,7 +3,7 @@
 
 # rise
 
-Powerful text interpolation.
+Powerful text interpolation. Documentation can be found here: 
 
 ## Installation
 
@@ -17,10 +17,9 @@ You can find binaries for the latest release on the [releases](https://github.co
 $ go get -u github.com/openpixel/rise
 ```
 
-## Usage
+## Quickstart
 
 ### CLI
-
 You can see the usage documation for the CLI by running `rise --help`.
 
 ```
@@ -37,17 +36,9 @@ Flags:
       --varFile stringSlice   The files that contains the variables to be interpolated
 ```
 
-#### Input (required)
-
-The input should be a string that references a file to run the interpolation against.
-
-#### Output (optional)
-
-The output is the location that the interpolated content should be written to. If not set, it will print to stdout.
+### Variable Files
 
-#### Variable Files (optional)
-
-The variable files should be in hcl compatible formats. See https://github.com/hashicorp/hcl for reference. Rise loads the files in the order they are supplied, so the latest reference of a variable will always be used. For example, if we had two files that looked like this
+The variable files should be in hcl compatible formats. See https://github.com/hashicorp/hcl for reference. Rise loads the files in the order they are supplied, so the latest reference of a variable will always be used. For example, if we had two files that looked like this:
 
 vars.hcl
 ```
@@ -71,33 +62,14 @@ $ rise ... --varFile vars.hcl --varFile vars2.hcl
 
 The value of `i` would be `10`.
 
-#### Basic Example
+### Examples
 
 Look in the [examples](https://github.com/OpenPixel/rise/tree/master/examples) directory for an example, including inheritance:
 
 ```
 $ rise -i ./examples/input.json -o ./examples/output.json --varFile ./examples/vars.hcl --varFile ./examples/vars2.hcl
 ```
 
-### API
-
-rise can also be used within Go code.
-
-```go
-import "github.com/openpixel/rise/template"
-
-vars := map[string]ast.Variable{}
-
-tmpl, err := template.NewTemplate(vars)
-// handle error
-
-input := `${lower("FOO")}`
-result, err := tmpl.Render(input)
-// handle error
-
-fmt.Printf("Value: %s", result.Value.(string)) // Value: foo
-```
-
 ## Coming Soon
 
 - More interpolation methods

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = rise
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,168 @@
+# -*- coding: utf-8 -*-
+#
+# rise documentation build configuration file, created by
+# sphinx-quickstart on Wed Dec  6 12:00:29 2017.
+#
+# 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.
+
+# 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.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- 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 = []
+
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'rise'
+copyright = u'2017, OpenPixel'
+author = u'OpenPixel'
+
+# 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 = u'0.0.3'
+# The full version, including alpha/beta/rc tags.
+release = u'v0.0.3'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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 = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+
+# 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 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'risedoc'
+
+
+# -- 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': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'rise.tex', u'rise Documentation',
+     u'OpenPixel', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'rise', u'rise Documentation',
+     [author], 1)
+]
+
+
+# -- 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 = [
+    (master_doc, 'rise', u'rise Documentation',
+     author, 'rise', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/index.rst

@@ -0,0 +1,30 @@
+.. rise documentation master file, created by
+   sphinx-quickstart on Wed Dec  6 12:00:29 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Introduction
+============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   self
+   installation
+   usage
+   interpolation/index
+
+Inspiration
+===========
+
+* `hashicorp/hil <https://github.com/hashicorp/hil>`_ - Used to perform interpolation
+* `hashicorp/hcl <https://github.com/hashicorp/hcl>`_ - Used as a configuration syntax for variables
+* `hashicorp/terraform <https://github.com/hashicorp/terraform>`_ - Inspiration for the tool. A number of the interpolation functions have been extracted directly from terraform.
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/installation.rst

@@ -0,0 +1,25 @@
+Installation
+------------
+
+There are multiple ways that rise can be installed.
+
+Binaries
+^^^^^^^^
+
+You can find binaries for the latest release on the `releases <https://github.com/OpenPixel/rise/releases>`_ page. For example, to install on linux:
+
+.. code-block:: sh
+
+   $ wget https://github.com/openpixel/rise/releases/download/v0.0.3/rise_0.0.3_linux_amd64.tar.gz
+   $ tar xvf rise_0.0.3_linux_amd64.tar.gz rise -C /usr/local/bin
+   $ which rise
+   /usr/local/bin/rise
+
+Go Toolchain
+^^^^^^^^^^^^
+
+As rise was written in Go, it can be installed via the Go toolchain:
+
+.. code-block:: sh
+
+   $ go get -u github.com/openpixel/rise

docs/interpolation/index.rst

@@ -0,0 +1,10 @@
+Interpolation
+=============
+
+Interpolation explanation.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   strings