started some docs

.gitignore

@@ -1,5 +1,6 @@
 *.pyc
 *.out
+*.xcf
 xonsh/lexer_table.py
 xonsh/parser_table.py 
 tests/lexer_table.py

docs/_static/numpy_friendly.css_t

@@ -0,0 +1,5 @@
+@import url("cloud.css");
+
+table.docutils th.field-name {
+    white-space: nowrap;
+}

docs/conf.py

@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# 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
+import cloud_sptheme as csp
+
+# -- General configuration -----------------------------------------------------
+
+# 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.doctest', 'sphinx.ext.pngmath',
+              'sphinx.ext.inheritance_diagram', 'sphinx.ext.viewcode',
+              'numpydoc', #'sphinx.ext.autosummary',
+              ]
+
+# 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'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'xonsh'
+copyright = u'2015, Anthony Scopatz'
+
+# 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.1'
+
+# The full version, including alpha/beta/rc tags.
+release = '0.1.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 documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# 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'
+#pygments_style = 'friendly'
+#pygments_style = 'bw'
+#pygments_style = 'fruity'
+#pygments_style = 'manni'
+#pygments_style = 'tango'
+#pygments_style = 'pastie'
+
+# 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.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+#html_theme = 'default'
+#html_theme = 'altered_nature'
+html_theme = 'cloud'
+#html_theme = 'sphinxdoc'
+
+# 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 = {
+    'max_width': '1250px',
+    'relbarbgcolor': '#000000',
+    'footerbgcolor': '#FFFFE7',
+    'sidebarwidth': '322px',
+    'sidebarbgcolor': '#e7e7ff', 
+    #'googleanalytics_id': 'UA-41934829-1',
+    'stickysidebar': False,
+    'highlighttoc': False,
+    'externalrefs': False,
+    }
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ["_theme", csp.get_theme_dir()]
+
+# 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 = '_static/ascii_conch_part_color.png'
+
+# 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 = '_static/magic_conch.ico'
+
+# 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']
+html_style = "numpy_friendly.css"
+
+# 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_use_modindex = 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, 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 = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'xonshdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'xonsh.tex', u'xonsh documentation',
+   u'Anthony Scopatz', '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
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+#Autodocumentation Flags
+autodoc_member_order = "groupwise"
+autoclass_content = "both"
+

docs/index.rst

@@ -0,0 +1,116 @@
+the xonsh shell
+===============
+
+.. raw:: html 
+
+    <p style="text-align:center;">
+    <span style="font-family:Times;font-size:28px;font-style:normal;font-weight:normal;text-decoration:none;text-transform:none;font-variant:small-caps;color:000000;">
+    <br />
+    ~ 
+    <script>
+    var phrases = [
+        "Exofrills in the shell",
+        "No frills in the shell",
+        "Become the Lord of the Files",
+        "Break out of your shell",
+        "It should not be that hard",
+        "Pass the xonsh, Piggy", 
+        "The shell, bourne again",
+        "Starfish loves you",
+        "Sally sells csh and keeps xonsh to herself",
+        ];
+    document.write(phrases[Math.floor(Math.random() * phrases.length)]);
+    </script>
+    ~
+    <br />
+    <br />
+    </span>
+    </p>
+
+Polyphemus is a continuous integration tool that front-ends to 
+`GitHub <https://github.com/>`_ et al. and backends to 
+`BaTLaB <https://www.batlab.org/>`_.  This fills a similar role to that of Travis-CI
+or the GitHub plugin for Jenkins.  However, BaTLab has a wider variety of machines
+than Travis-CI and is cheaper (free) than running your own machines with Jenkins.
+
+=========
+Contents
+=========
+
+.. toctree::
+    :maxdepth: 1
+
+    tutorial
+    batlab
+    api/index
+    rcdocs
+    previous/index
+    faq
+    other
+    authors
+
+============
+Installation
+============
+Since polyphemus is pure Python code, the ``pip`` or ``easy_install`` may be used
+to grab and install the code::
+
+    $ pip install polyphemus
+
+    $ easy_install polyphemus
+
+
+The source code repository for polyphemus may be found at the 
+`GitHub project site <http://github.com/polyphemus-ci/polyphemus>`_.
+You may simply clone the development branch using git::
+
+    git clone git://github.com/polyphemus-ci/polyphemus.git
+
+Also, if you wish to have the optional BASH completion, please add the 
+following lines to your ``~/.bashrc`` file::
+
+    # Enable completion for polyphemus
+    eval "$(register-python-argcomplete polyphemus)"
+
+============
+Dependencies
+============
+Polyphemus currently has the following external dependencies,
+
+*Run Time:*
+
+    #. `flask <http://flask.pocoo.org/>`_
+    #. `paramiko <http://www.lag.net/paramiko/>`_
+    #. `github3.py <http://github3py.readthedocs.org/en/latest/>`_
+    #. `argcomplete <https://argcomplete.readthedocs.org/en/latest/>`_, optional for BASH completion
+    #. `apache 2 <http://httpd.apache.org/>`_, optional for real deployment
+    #. `modwsgi <https://code.google.com/p/modwsgi/>`_, optional for apache
+
+==========
+Contact Us
+==========
+If you have questions or comments, please send them to the mailing list
+polyphemus-ci@googlegroups.com or contact the author directly or open an issue on
+GitHub. 
+`Join the mailing list here! <https://groups.google.com/forum/#!forum/polyphemus-ci>`_
+
+============
+Contributing
+============
+We highly encourage contributions to polyphemus!  If you would like to contribute, 
+it is as easy as forking the repository on GitHub, making your changes, and 
+issuing a pull request.  If you have any questions about this process don't 
+hesitate to ask the mailing list (polyphemus-ci@googlegroups.com). We are particularly
+interested in adding bitbucket and mercurial support.
+
+=============
+Helpful Links
+=============
+
+* `Documentation <http://xonsh.org>`_
+* `Mailing list <https://groups.google.com/forum/#!forum/polyphemus-ci>`_
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+