Add sphinx documentation, initital commit

5 files changed, 432 insertions, 0 deletions

diff --git a/docs/source/code.rst b/docs/source/code.rst
new file mode 100644
index 0000000..9fcb413
--- /dev/null
+++ b/docs/source/code.rst
@@ -0,0 +1,16 @@
+Code Reference
+**************
+
+.. automodule:: ipsutils
+	:members: 
+
+.. autoclass:: ipsutils.build.Build
+	:members: __init__
+
+.. autoclass:: ipsutils.config.Config
+	:members: __init__
+
+.. autoclass:: ipsutils.env.Environment
+	:members: __init__
+
+
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..fa07dd3
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,246 @@
+# -*- coding: utf-8 -*-
+#
+# ipsutils documentation build configuration file, created by
+# sphinx-quickstart on Mon Jun 17 14:58:59 2013.
+#
+# 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('..'))
+
+# -- 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.intersphinx', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']
+
+# 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'ipsutils'
+copyright = u'2013, Joseph Hunkeler'
+
+# 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.6.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.6.0'
+
+# 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 = 'ipsutilsdoc'
+
+
+# -- 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', 'ipsutils.tex', u'ipsutils Documentation',
+   u'Joseph Hunkeler', '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', 'ipsutils', u'ipsutils Documentation',
+     [u'Joseph Hunkeler'], 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', 'ipsutils', u'ipsutils Documentation',
+   u'Joseph Hunkeler', 'ipsutils', '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'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..d2f01d3
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,24 @@
+.. ipsutils documentation master file, created by
+   sphinx-quickstart on Mon Jun 17 14:58:59 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ipsutils's documentation!
+====================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   spec_file_format
+   tutorial
+   code
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/source/spec_file_format.rst b/docs/source/spec_file_format.rst
new file mode 100644
index 0000000..8491ef1
--- /dev/null
+++ b/docs/source/spec_file_format.rst
@@ -0,0 +1,137 @@
+SPEC File Format
+****************
+
+Keywords
+========
+
+* **name** - The name of the package
+* **repackage** - Change name of package
+* **version** - Version of package
+* **release** - Release number of package
+* **maintainer** - Name and email address of current package maintainer
+
+* **group** - Name of group the package belongs to
+* **upstream_url** - URL to package in repository
+* **source_url** - URL to original source package
+* **description** - Full description of package
+* **summary** - Brief description of package
+* **classification** - opensolaris package classification format [1]_
+* **arch** - Destined architecture of the package
+* **license** - License of the package
+
+Directives
+==========
+
+.. note::
+   All commands issued in a directive block are processed by Bourne-Again Shell,
+   except for *%transforms*
+
+.. note::
+   Directives must be closed with the **%end** tag
+
+%prep
+-----
+
+Set of commands to be executed *before building*;
+such as applying patches to source code in the $BUILD directory, changing
+pre-configuration data, etc.
+
+Example::
+
+   %prep
+   # Apply various patches
+   patch -i $SOURCES/$name-$version-some_fixes.patch
+   
+   # Change execution path of all scripts
+   find $BUILD -type f -name "*.py" -exec sed -i -e 's|\!#/usr/local|\!#/usr/bin|g' {} \;
+   
+   %end
+
+%build
+------
+
+Set of commands to be executed as part of the build process;
+such as running any configuration scripts, and compiling your application(s).
+
+Example::
+
+   %build
+   ./configure --prefix=/opt --with-pymalloc
+   make -j2
+   
+   %end
+
+%install
+--------
+
+Set of commands to executed as part of the installation process;
+such as moving data to the build installation directory after being compiled.
+
+Example::
+   %install
+   make install DESTDIR=$BUILDPROTO
+   %end
+
+
+%transforms
+-----------
+
+A syntatical reference is available from `oracle's transforms documentation <http://docs.oracle.com/cd/E26502_01/html/E21383/xformrules.html>`_
+
+
+Available shell expansion variables
+===================================
+
+* **BUILDROOT** - ipsutils/BUILDROOT/[package]
+* **BUILDPROTO** - ipsutils/BUILDROOT/[package]/root
+* **BUILD** - ipsutils/BUILD/[package]
+* **SOURCES** - ipsutils/SOURCES/[package source_url basename]
+* **PKGS** - ipsutils/PKGS/[package]
+* **SPKGS** - ipsutils/SPKGS/[package]
+
+.. note::
+   Macro expansion for ipsutils is in its infancy.  If you are familiar with macro expansion
+   in RPM's SPEC implementation; there is nothing even remotely close to it here.  This will be
+   addressed in the future.
+
+SPEC file example
+=================
+
+This is a generic example of an IPS spec file
+
+::
+
+   name:           ipsutils
+   version:        0.6.0
+   release:        1
+   maintainer:     "Joseph Hunkeler <jhunk@stsci.edu>"
+   upstream_url:   http://localhost/$name-$version.tar.gz
+   source_url:     http://localhost/$name-$version.tar.gz
+   description:    "Python IPS library"
+   summary:        "A python based IPS library"
+   group:          developer
+   classification: "org.opensolaris.category.2008:Development/Distribution Tools"
+   arch:           i386
+   license:        GPL
+   
+   %prep
+   %end
+   
+   %build
+   python setup.py build
+   
+   %end
+   
+   %install
+   python setup.py install --root=$BUILDPROTO --prefix=/opt/ipsutils
+   %end
+   
+   %transforms
+   <transform dir path=opt$ -> edit group bin sys>
+   %end
+
+   
+Footnotes
+=========
+
+.. [1] `IPS package classifications <http://docs.oracle.com/cd/E26502_01/html/E21383/gentextid-3283.html#scrolltoc>`_
\ No newline at end of file
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
new file mode 100644
index 0000000..f1de3d1
--- /dev/null
+++ b/docs/source/tutorial.rst
@@ -0,0 +1,9 @@
+Tutorial
+********
+
+.. SPEC File Format_: spec_file_format
+
+Creating an IPS package from scratch
+====================================
+
+Please take a few minutes to review `SPEC File Format <spec_file_format.html>`_
\ No newline at end of file