Added Sphinx documentation initial

Leonardo J. Caballero G
1 parent 7de977b2
Showing 8 changed files with 974 additions and 0 deletions Show diff stats
docs/Makefile
docs/_static/logo_small.png
docs/about.rst
docs/conf.py
docs/index.rst
docs/install.rst
docs/make.bat
docs/ubuntu1004.rst
@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ColabSoftwareDocumentation.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ColabSoftwareDocumentation.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/ColabSoftwareDocumentation"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ColabSoftwareDocumentation"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
@@ -0,0 +1,35 @@
+.. -*- coding: utf-8 -*-
+
+.. highlight:: rest
+
+.. _colab_software:
+
+What is Colab?
+==============
+
+Application that integrates existing systems to represent the contributions of the members through:
+
+* The amendments to the Wiki trac system.
+
+* Changes to the trac system code.
+
+* Discussions at the mailman list.
+
+* And other systems in the community.
+
+Features
+--------
+
+* Developerd by Interlegis Communities http://colab.interlegis.leg.br/
+
+* Writed with Python http://python.org/
+
+* Build in Django Web Framework https://www.djangoproject.com/
+
+* Search engine with Solr https://lucene.apache.org/solr/
+
+Integration with Solr
+---------------------
+
+This software uses Apache Solr as search platform based on Apache Lucene.
+
@@ -0,0 +1,306 @@
+# -*- coding: utf-8 -*-
+#
+# Colab Software documentation build configuration file, created by
+# sphinx-quickstart on Mon Oct 14 15:16:49 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.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'Colab Software'
+copyright = u'2013, Leonardo J. Caballero G.'
+
+# 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'
+
+# 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 = ['_build']
+
+# 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 = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = 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 = '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 = 'ColabSoftwareDocumentationdoc'
+
+
+# -- 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', 'ColabSoftwareDocumentation.tex', u'Colab Software',
+   u'Leonardo J. Caballero G.', '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', 'colabsoftwaredocumentation', u'Colab Software',
+     [u'Leonardo J. Caballero G.'], 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', 'ColabSoftwareDocumentation', u'Colab Software',
+   u'Leonardo J. Caballero G.', 'ColabSoftwareDocumentation', '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'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'Colab Software Documentation'
+epub_author = u'Leonardo J. Caballero G.'
+epub_publisher = u'Leonardo J. Caballero G.'
+epub_copyright = u'2013, Leonardo J. Caballero G.'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+# Fix unsupported image types using the PIL.
+#epub_fix_images = False
+
+# Scale large images.
+#epub_max_image_width = 0
+
+# If 'no', URL addresses will not be shown.
+#epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#epub_use_index = True
@@ -0,0 +1,25 @@
+.. Colab Software documentation master file, created by
+   sphinx-quickstart on Mon Oct 14 15:16:49 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+=================================
+Colab, a Software for Communities
+=================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   about
+   install
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
@@ -0,0 +1,15 @@
+.. -*- coding: utf-8 -*-
+
+.. highlight:: rest
+
+.. _colab_software_install:
+
+Installation
+============
+
+Colab software can be install in many Linux distros, like these:
+
+.. toctree::
+   :maxdepth: 1
+
+   ubuntu1004
@@ -0,0 +1,242 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  xml        to make Docutils-native XML files
+	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ColabSoftwareDocumentation.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ColabSoftwareDocumentation.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdf" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf
+	cd %BUILDDIR%/..
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdfja" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf-ja
+	cd %BUILDDIR%/..
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+if "%1" == "xml" (
+	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The XML files are in %BUILDDIR%/xml.
+	goto end
+)
+
+if "%1" == "pseudoxml" (
+	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+	goto end
+)
+
+:end
@@ -0,0 +1,174 @@
+.. -*- coding: utf-8 -*-
+
+.. highlight:: rest
+
+.. _ubuntu1004_install:
+
+Installation instructions for Ubuntu 10.04
+==========================================
+
+.. contents :: :local:
+
+Install Solr and dependencies
+-----------------------------
+
+* Install Java, tomcat, JDBC Postgres drivers (Ubuntu partner repositories must be enabled): ::
+
+    sudo apt-get install sun-java6-bin tomcat6 libpg-java
+
+* Download Solr 3.3 and extract it: ::
+
+    wget http://archive.apache.org/dist/lucene/solr/3.3.0/apache-solr-3.3.0.tgz
+    tar xzf apache-solr-3.3.0.tgz 
+
+* Create the directory ``/var/local/lib/solr/`` and give the right permissions: ::
+
+    sudo mkdir -p /var/local/lib/solr/
+    sudo chown tomcat6:tomcat6 /var/local/lib/solr/
+
+* Copy the solr home example to ``/usr/local/share/``: ::
+
+    sudo cp -R apache-solr-3.3.0/example/solr /usr/local/share/
+
+* Create a folder for libs in the solr home: ::
+
+    sudo mkdir /usr/local/share/solr/lib/
+
+* Copy Solr libs to libs folder: ::
+
+    sudo cp apache-solr-3.3.0/dist/*.jar /usr/local/share/solr/lib/
+
+* Copy Solr distribution to solr home: ::
+
+    sudo cp apache-solr-3.3.0/dist/apache-solr-3.3.0.war /usr/local/share/solr/
+
+* Link the JDBC Postgres drivers into the Solr installation: ::
+
+    sudo ln -s /usr/share/java/postgresql-jdbc3-8.4.jar /usr/local/share/solr/lib/
+
+* Link configurations to ``/etc`` ::
+
+    sudo ln -s /usr/local/share/solr/conf/ /etc/solr
+
+* Copy the configuration files from this folder into ``/etc/solr/``
+
+* Link the ``solr-tomcat.xml`` file in the Tomcat configuration: ::
+
+    sudo ln -s /etc/solr/solr-tomcat.xml /etc/tomcat6/Catalina/localhost/solr.xml 
+
+* Check ``data-config.xml`` to make sure all information to connect to the databases are right
+
+* Create a ``dataimport.properties`` on ``/etc/solr`` and give write access to ``tomcat6``: ::
+
+    sudo touch /etc/solr/dataimport.properties
+    sudo chown tomcat6:tomcat6 /etc/solr/dataimport.properties
+ 
+* Restart tomcat: ::
+
+    sudo /etc/init.d/tomcat6 restart
+
+Install Colab and dependencies
+------------------------------
+
+* Install Apache2 with WSGI support: ::
+
+    sudo apt-get install apache2 libapache2-mod-wsgi
+
+* Install dependencies to compile psycopg2: ::
+
+    sudo apt-get build-dep python-psycopg2
+
+* Install Python PIP and update it: ::
+
+    sudo apt-get install python-pip
+    sudo pip install -U pip
+
+* Install python virtualenv: ::
+
+    sudo pip install virtualenv 
+
+* Create a virtualenv for the deploy ::
+ 
+    sudo mkdir /usr/local/django/
+    sudo virtualenv /usr/local/django/colab/
+
+* Download the colab ``src`` code: ::
+
+    sudo hg clone https://bitbucket.org/seocam/atu-colab /usr/local/src/colab/
+
+* Install the django site: ::
+
+    sudo pip install /usr/local/src/colab -E /usr/local/django/colab/
+
+* Configure your database settings in ``/usr/local/django/colab/lib/python2.6/site-packages/settings_local.py``
+  
+* Enable the colab site on apache and reload it: ::
+
+    sudo ln -s /usr/local/django/colab/apache-site/colab /etc/apache2/sites-available
+    sudo a2ensite colab
+    sudo service apache2 restart
+
+Configuring server to send emails
+----------------------------------
+
+* Install postfix and mailutils: ::
+
+    sudo apt-get install mailutils postfix
+
+* Update the file ``/etc/aliases`` adding users that should receive root's messages and run the update command: ::
+
+    sudo newaliases
+
+
+Cron job to import emails
+---------------------------
+
+* Install sshfs: ::
+
+    sudo apt-get install sshfs autofs
+
+* Create SSH keys. You should use a password but this tutorial won't cover it (if you use you will need to install and configure keychain process to be able to proceed): ::
+
+    sudo ssh-keygen
+
+* Copy the content of your key (``/root/.ssh/id_rsa.pub``) to the file ``/root/.ssh/authorized_keys`` on the mailinglist server.
+
+* Append the following content to /etc/auto.master file: ::
+
+    sudo /usr/local/django/colab/mnt /usr/local/django/colab/autofs/listas --timeout=600,--ghost
+
+* Restart autofs: ::
+
+    service autofs restart
+  
+* Link cron script into ``/etc/cron.d/`` folder: ::
+
+    ln -s /usr/local/django/colab/cron.d/colab_import_emails /etc/cron.d/ 
+  
+* From now on the emails should be imported every minute
+
+
+Cron job to reindex Solr
+-------------------------
+
+* Install wget: ::
+
+    sudo apt-get install wget
+
+* Link cron script into ``/etc/cron.d/`` folder: ::
+
+    sudo ln -s /usr/local/django/colab/cron.d/colab_solr_reindex /etc/cron.d/
+
+* From now on delta reindex should run every 10 minutes and full reindex once a day. 
+
+
+Updating an installed version
+------------------------------
+
+* Update the source code: ::
+
+    sudo cd /usr/local/src/colab/
+    sudo hg pull
+    sudo hg up
+    sudo pip install /usr/local/src/colab/ -E /usr/local/django/colab/ -U
+    sudo service apache2 restart
...	...	@@ -0,0 +1,177 @@
	1	+# Makefile for Sphinx documentation
	2	+#
	3	+
	4	+# You can set these variables from the command line.
	5	+SPHINXOPTS =
	6	+SPHINXBUILD = sphinx-build
	7	+PAPER =
	8	+BUILDDIR = _build
	9	+
	10	+# User-friendly check for sphinx-build
	11	+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
	12	+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
	13	+endif
	14	+
	15	+# Internal variables.
	16	+PAPEROPT_a4 = -D latex_paper_size=a4
	17	+PAPEROPT_letter = -D latex_paper_size=letter
	18	+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
	19	+# the i18n builder cannot share the environment and doctrees with the others
	20	+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
	21	+
	22	+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
	23	+
	24	+help:
	25	+ @echo "Please use \`make <target>' where <target> is one of"
	26	+ @echo " html to make standalone HTML files"
	27	+ @echo " dirhtml to make HTML files named index.html in directories"
	28	+ @echo " singlehtml to make a single large HTML file"
	29	+ @echo " pickle to make pickle files"
	30	+ @echo " json to make JSON files"
	31	+ @echo " htmlhelp to make HTML files and a HTML help project"
	32	+ @echo " qthelp to make HTML files and a qthelp project"
	33	+ @echo " devhelp to make HTML files and a Devhelp project"
	34	+ @echo " epub to make an epub"
	35	+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	36	+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
	37	+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
	38	+ @echo " text to make text files"
	39	+ @echo " man to make manual pages"
	40	+ @echo " texinfo to make Texinfo files"
	41	+ @echo " info to make Texinfo files and run them through makeinfo"
	42	+ @echo " gettext to make PO message catalogs"
	43	+ @echo " changes to make an overview of all changed/added/deprecated items"
	44	+ @echo " xml to make Docutils-native XML files"
	45	+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
	46	+ @echo " linkcheck to check all external links for integrity"
	47	+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
	48	+
	49	+clean:
	50	+ rm -rf $(BUILDDIR)/*
	51	+
	52	+html:
	53	+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
	54	+ @echo
	55	+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
	56	+
	57	+dirhtml:
	58	+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
	59	+ @echo
	60	+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
	61	+
	62	+singlehtml:
	63	+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
	64	+ @echo
	65	+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
	66	+
	67	+pickle:
	68	+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
	69	+ @echo
	70	+ @echo "Build finished; now you can process the pickle files."
	71	+
	72	+json:
	73	+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
	74	+ @echo
	75	+ @echo "Build finished; now you can process the JSON files."
	76	+
	77	+htmlhelp:
	78	+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
	79	+ @echo
	80	+ @echo "Build finished; now you can run HTML Help Workshop with the" \
	81	+ ".hhp project file in $(BUILDDIR)/htmlhelp."
	82	+
	83	+qthelp:
	84	+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
	85	+ @echo
	86	+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
	87	+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
	88	+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ColabSoftwareDocumentation.qhcp"
	89	+ @echo "To view the help file:"
	90	+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ColabSoftwareDocumentation.qhc"
	91	+
	92	+devhelp:
	93	+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
	94	+ @echo
	95	+ @echo "Build finished."
	96	+ @echo "To view the help file:"
	97	+ @echo "# mkdir -p $$HOME/.local/share/devhelp/ColabSoftwareDocumentation"
	98	+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ColabSoftwareDocumentation"
	99	+ @echo "# devhelp"
	100	+
	101	+epub:
	102	+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
	103	+ @echo
	104	+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
	105	+
	106	+latex:
	107	+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
	108	+ @echo
	109	+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
	110	+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
	111	+ "(use \`make latexpdf' here to do that automatically)."
	112	+
	113	+latexpdf:
	114	+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
	115	+ @echo "Running LaTeX files through pdflatex..."
	116	+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
	117	+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
	118	+
	119	+latexpdfja:
	120	+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
	121	+ @echo "Running LaTeX files through platex and dvipdfmx..."
	122	+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
	123	+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
	124	+
	125	+text:
	126	+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
	127	+ @echo
	128	+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
	129	+
	130	+man:
	131	+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
	132	+ @echo
	133	+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
	134	+
	135	+texinfo:
	136	+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
	137	+ @echo
	138	+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
	139	+ @echo "Run \`make' in that directory to run these through makeinfo" \
	140	+ "(use \`make info' here to do that automatically)."
	141	+
	142	+info:
	143	+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
	144	+ @echo "Running Texinfo files through makeinfo..."
	145	+ make -C $(BUILDDIR)/texinfo info
	146	+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
	147	+
	148	+gettext:
	149	+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
	150	+ @echo
	151	+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
	152	+
	153	+changes:
	154	+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
	155	+ @echo
	156	+ @echo "The overview file is in $(BUILDDIR)/changes."
	157	+
	158	+linkcheck:
	159	+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
	160	+ @echo
	161	+ @echo "Link check complete; look for any errors in the above output " \
	162	+ "or in $(BUILDDIR)/linkcheck/output.txt."
	163	+
	164	+doctest:
	165	+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
	166	+ @echo "Testing of doctests in the sources finished, look at the " \
	167	+ "results in $(BUILDDIR)/doctest/output.txt."
	168	+
	169	+xml:
	170	+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
	171	+ @echo
	172	+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
	173	+
	174	+pseudoxml:
	175	+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
	176	+ @echo
	177	+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
...	...
...	...	@@ -0,0 +1,35 @@
	1	+.. -- coding: utf-8 --
	2	+
	3	+.. highlight:: rest
	4	+
	5	+.. _colab_software:
	6	+
	7	+What is Colab?
	8	+==============
	9	+
	10	+Application that integrates existing systems to represent the contributions of the members through:
	11	+
	12	+* The amendments to the Wiki trac system.
	13	+
	14	+* Changes to the trac system code.
	15	+
	16	+* Discussions at the mailman list.
	17	+
	18	+* And other systems in the community.
	19	+
	20	+Features
	21	+--------
	22	+
	23	+* Developerd by Interlegis Communities http://colab.interlegis.leg.br/
	24	+
	25	+* Writed with Python http://python.org/
	26	+
	27	+* Build in Django Web Framework https://www.djangoproject.com/
	28	+
	29	+* Search engine with Solr https://lucene.apache.org/solr/
	30	+
	31	+Integration with Solr
	32	+---------------------
	33	+
	34	+This software uses Apache Solr as search platform based on Apache Lucene.
	35	+
...	...
...	...	@@ -0,0 +1,306 @@
	1	+# -- coding: utf-8 --
	2	+#
	3	+# Colab Software documentation build configuration file, created by
	4	+# sphinx-quickstart on Mon Oct 14 15:16:49 2013.
	5	+#
	6	+# This file is execfile()d with the current directory set to its containing dir.
	7	+#
	8	+# Note that not all possible configuration values are present in this
	9	+# autogenerated file.
	10	+#
	11	+# All configuration values have a default; values that are commented out
	12	+# serve to show the default.
	13	+
	14	+import sys, os
	15	+
	16	+# If extensions (or modules to document with autodoc) are in another directory,
	17	+# add these directories to sys.path here. If the directory is relative to the
	18	+# documentation root, use os.path.abspath to make it absolute, like shown here.
	19	+#sys.path.insert(0, os.path.abspath('.'))
	20	+
	21	+# -- General configuration -----------------------------------------------------
	22	+
	23	+# If your documentation needs a minimal Sphinx version, state it here.
	24	+#needs_sphinx = '1.0'
	25	+
	26	+# Add any Sphinx extension module names here, as strings. They can be extensions
	27	+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
	28	+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage']
	29	+
	30	+# Add any paths that contain templates here, relative to this directory.
	31	+templates_path = ['_templates']
	32	+
	33	+# The suffix of source filenames.
	34	+source_suffix = '.rst'
	35	+
	36	+# The encoding of source files.
	37	+#source_encoding = 'utf-8-sig'
	38	+
	39	+# The master toctree document.
	40	+master_doc = 'index'
	41	+
	42	+# General information about the project.
	43	+project = u'Colab Software'
	44	+copyright = u'2013, Leonardo J. Caballero G.'
	45	+
	46	+# The version info for the project you're documenting, acts as replacement for
	47	+# \|version\| and \|release\|, also used in various other places throughout the
	48	+# built documents.
	49	+#
	50	+# The short X.Y version.
	51	+version = '0.1'
	52	+# The full version, including alpha/beta/rc tags.
	53	+release = '0.1'
	54	+
	55	+# The language for content autogenerated by Sphinx. Refer to documentation
	56	+# for a list of supported languages.
	57	+#language = None
	58	+
	59	+# There are two options for replacing \|today\|: either, you set today to some
	60	+# non-false value, then it is used:
	61	+#today = ''
	62	+# Else, today_fmt is used as the format for a strftime call.
	63	+#today_fmt = '%B %d, %Y'
	64	+
	65	+# List of patterns, relative to source directory, that match files and
	66	+# directories to ignore when looking for source files.
	67	+exclude_patterns = ['_build']
	68	+
	69	+# The reST default role (used for this markup: `text`) to use for all documents.
	70	+#default_role = None
	71	+
	72	+# If true, '()' will be appended to :func: etc. cross-reference text.
	73	+#add_function_parentheses = True
	74	+
	75	+# If true, the current module name will be prepended to all description
	76	+# unit titles (such as .. function::).
	77	+#add_module_names = True
	78	+
	79	+# If true, sectionauthor and moduleauthor directives will be shown in the
	80	+# output. They are ignored by default.
	81	+#show_authors = False
	82	+
	83	+# The name of the Pygments (syntax highlighting) style to use.
	84	+pygments_style = 'sphinx'
	85	+
	86	+# A list of ignored prefixes for module index sorting.
	87	+#modindex_common_prefix = []
	88	+
	89	+# If true, keep warnings as "system message" paragraphs in the built documents.
	90	+#keep_warnings = False
	91	+
	92	+
	93	+# -- Options for HTML output ---------------------------------------------------
	94	+
	95	+# The theme to use for HTML and HTML Help pages. See the documentation for
	96	+# a list of builtin themes.
	97	+html_theme = 'default'
	98	+
	99	+# Theme options are theme-specific and customize the look and feel of a theme
	100	+# further. For a list of options available for each theme, see the
	101	+# documentation.
	102	+#html_theme_options = {}
	103	+
	104	+# Add any paths that contain custom themes here, relative to this directory.
	105	+#html_theme_path = []
	106	+
	107	+# The name for this set of Sphinx documents. If None, it defaults to
	108	+# "<project> v<release> documentation".
	109	+#html_title = None
	110	+
	111	+# A shorter title for the navigation bar. Default is the same as html_title.
	112	+#html_short_title = None
	113	+
	114	+# The name of an image file (relative to this directory) to place at the top
	115	+# of the sidebar.
	116	+#html_logo = None
	117	+
	118	+# The name of an image file (within the static path) to use as favicon of the
	119	+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
	120	+# pixels large.
	121	+#html_favicon = None
	122	+
	123	+# Add any paths that contain custom static files (such as style sheets) here,
	124	+# relative to this directory. They are copied after the builtin static files,
	125	+# so a file named "default.css" will overwrite the builtin "default.css".
	126	+html_static_path = ['_static']
	127	+
	128	+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
	129	+# using the given strftime format.
	130	+#html_last_updated_fmt = '%b %d, %Y'
	131	+
	132	+# If true, SmartyPants will be used to convert quotes and dashes to
	133	+# typographically correct entities.
	134	+#html_use_smartypants = True
	135	+
	136	+# Custom sidebar templates, maps document names to template names.
	137	+#html_sidebars = {}
	138	+
	139	+# Additional templates that should be rendered to pages, maps page names to
	140	+# template names.
	141	+#html_additional_pages = {}
	142	+
	143	+# If false, no module index is generated.
	144	+#html_domain_indices = True
	145	+
	146	+# If false, no index is generated.
	147	+#html_use_index = True
	148	+
	149	+# If true, the index is split into individual pages for each letter.
	150	+#html_split_index = False
	151	+
	152	+# If true, links to the reST sources are added to the pages.
	153	+#html_show_sourcelink = True
	154	+
	155	+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
	156	+#html_show_sphinx = True
	157	+
	158	+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
	159	+#html_show_copyright = True
	160	+
	161	+# If true, an OpenSearch description file will be output, and all pages will
	162	+# contain a <link> tag referring to it. The value of this option must be the
	163	+# base URL from which the finished HTML is served.
	164	+#html_use_opensearch = ''
	165	+
	166	+# This is the file name suffix for HTML files (e.g. ".xhtml").
	167	+#html_file_suffix = None
	168	+
	169	+# Output file base name for HTML help builder.
	170	+htmlhelp_basename = 'ColabSoftwareDocumentationdoc'
	171	+
	172	+
	173	+# -- Options for LaTeX output --------------------------------------------------
	174	+
	175	+latex_elements = {
	176	+# The paper size ('letterpaper' or 'a4paper').
	177	+#'papersize': 'letterpaper',
	178	+
	179	+# The font size ('10pt', '11pt' or '12pt').
	180	+#'pointsize': '10pt',
	181	+
	182	+# Additional stuff for the LaTeX preamble.
	183	+#'preamble': '',
	184	+}
	185	+
	186	+# Grouping the document tree into LaTeX files. List of tuples
	187	+# (source start file, target name, title, author, documentclass [howto/manual]).
	188	+latex_documents = [
	189	+ ('index', 'ColabSoftwareDocumentation.tex', u'Colab Software',
	190	+ u'Leonardo J. Caballero G.', 'manual'),
	191	+]
	192	+
	193	+# The name of an image file (relative to this directory) to place at the top of
	194	+# the title page.
	195	+#latex_logo = None
	196	+
	197	+# For "manual" documents, if this is true, then toplevel headings are parts,
	198	+# not chapters.
	199	+#latex_use_parts = False
	200	+
	201	+# If true, show page references after internal links.
	202	+#latex_show_pagerefs = False
	203	+
	204	+# If true, show URL addresses after external links.
	205	+#latex_show_urls = False
	206	+
	207	+# Documents to append as an appendix to all manuals.
	208	+#latex_appendices = []
	209	+
	210	+# If false, no module index is generated.
	211	+#latex_domain_indices = True
	212	+
	213	+
	214	+# -- Options for manual page output --------------------------------------------
	215	+
	216	+# One entry per manual page. List of tuples
	217	+# (source start file, name, description, authors, manual section).
	218	+man_pages = [
	219	+ ('index', 'colabsoftwaredocumentation', u'Colab Software',
	220	+ [u'Leonardo J. Caballero G.'], 1)
	221	+]
	222	+
	223	+# If true, show URL addresses after external links.
	224	+#man_show_urls = False
	225	+
	226	+
	227	+# -- Options for Texinfo output ------------------------------------------------
	228	+
	229	+# Grouping the document tree into Texinfo files. List of tuples
	230	+# (source start file, target name, title, author,
	231	+# dir menu entry, description, category)
	232	+texinfo_documents = [
	233	+ ('index', 'ColabSoftwareDocumentation', u'Colab Software',
	234	+ u'Leonardo J. Caballero G.', 'ColabSoftwareDocumentation', 'One line description of project.',
	235	+ 'Miscellaneous'),
	236	+]
	237	+
	238	+# Documents to append as an appendix to all manuals.
	239	+#texinfo_appendices = []
	240	+
	241	+# If false, no module index is generated.
	242	+#texinfo_domain_indices = True
	243	+
	244	+# How to display URL addresses: 'footnote', 'no', or 'inline'.
	245	+#texinfo_show_urls = 'footnote'
	246	+
	247	+# If true, do not generate a @detailmenu in the "Top" node's menu.
	248	+#texinfo_no_detailmenu = False
	249	+
	250	+
	251	+# -- Options for Epub output ---------------------------------------------------
	252	+
	253	+# Bibliographic Dublin Core info.
	254	+epub_title = u'Colab Software Documentation'
	255	+epub_author = u'Leonardo J. Caballero G.'
	256	+epub_publisher = u'Leonardo J. Caballero G.'
	257	+epub_copyright = u'2013, Leonardo J. Caballero G.'
	258	+
	259	+# The language of the text. It defaults to the language option
	260	+# or en if the language is not set.
	261	+#epub_language = ''
	262	+
	263	+# The scheme of the identifier. Typical schemes are ISBN or URL.
	264	+#epub_scheme = ''
	265	+
	266	+# The unique identifier of the text. This can be a ISBN number
	267	+# or the project homepage.
	268	+#epub_identifier = ''
	269	+
	270	+# A unique identification for the text.
	271	+#epub_uid = ''
	272	+
	273	+# A tuple containing the cover image and cover page html template filenames.
	274	+#epub_cover = ()
	275	+
	276	+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
	277	+#epub_guide = ()
	278	+
	279	+# HTML files that should be inserted before the pages created by sphinx.
	280	+# The format is a list of tuples containing the path and title.
	281	+#epub_pre_files = []
	282	+
	283	+# HTML files shat should be inserted after the pages created by sphinx.
	284	+# The format is a list of tuples containing the path and title.
	285	+#epub_post_files = []
	286	+
	287	+# A list of files that should not be packed into the epub file.
	288	+#epub_exclude_files = []
	289	+
	290	+# The depth of the table of contents in toc.ncx.
	291	+#epub_tocdepth = 3
	292	+
	293	+# Allow duplicate toc entries.
	294	+#epub_tocdup = True
	295	+
	296	+# Fix unsupported image types using the PIL.
	297	+#epub_fix_images = False
	298	+
	299	+# Scale large images.
	300	+#epub_max_image_width = 0
	301	+
	302	+# If 'no', URL addresses will not be shown.
	303	+#epub_show_urls = 'inline'
	304	+
	305	+# If false, no index is generated.
	306	+#epub_use_index = True
...	...
...	...	@@ -0,0 +1,25 @@
	1	+.. Colab Software documentation master file, created by
	2	+ sphinx-quickstart on Mon Oct 14 15:16:49 2013.
	3	+ You can adapt this file completely to your liking, but it should at least
	4	+ contain the root `toctree` directive.
	5	+
	6	+=================================
	7	+Colab, a Software for Communities
	8	+=================================
	9	+
	10	+Contents:
	11	+
	12	+.. toctree::
	13	+ :maxdepth: 2
	14	+
	15	+ about
	16	+ install
	17	+
	18	+
	19	+Indices and tables
	20	+==================
	21	+
	22	+* :ref:`genindex`
	23	+* :ref:`modindex`
	24	+* :ref:`search`
	25	+
...	...
...	...	@@ -0,0 +1,15 @@
	1	+.. -- coding: utf-8 --
	2	+
	3	+.. highlight:: rest
	4	+
	5	+.. _colab_software_install:
	6	+
	7	+Installation
	8	+============
	9	+
	10	+Colab software can be install in many Linux distros, like these:
	11	+
	12	+.. toctree::
	13	+ :maxdepth: 1
	14	+
	15	+ ubuntu1004
...	...
...	...	@@ -0,0 +1,242 @@
	1	+@ECHO OFF
	2	+
	3	+REM Command file for Sphinx documentation
	4	+
	5	+if "%SPHINXBUILD%" == "" (
	6	+ set SPHINXBUILD=sphinx-build
	7	+)
	8	+set BUILDDIR=_build
	9	+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
	10	+set I18NSPHINXOPTS=%SPHINXOPTS% .
	11	+if NOT "%PAPER%" == "" (
	12	+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
	13	+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
	14	+)
	15	+
	16	+if "%1" == "" goto help
	17	+
	18	+if "%1" == "help" (
	19	+ :help
	20	+ echo.Please use `make ^<target^>` where ^<target^> is one of
	21	+ echo. html to make standalone HTML files
	22	+ echo. dirhtml to make HTML files named index.html in directories
	23	+ echo. singlehtml to make a single large HTML file
	24	+ echo. pickle to make pickle files
	25	+ echo. json to make JSON files
	26	+ echo. htmlhelp to make HTML files and a HTML help project
	27	+ echo. qthelp to make HTML files and a qthelp project
	28	+ echo. devhelp to make HTML files and a Devhelp project
	29	+ echo. epub to make an epub
	30	+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
	31	+ echo. text to make text files
	32	+ echo. man to make manual pages
	33	+ echo. texinfo to make Texinfo files
	34	+ echo. gettext to make PO message catalogs
	35	+ echo. changes to make an overview over all changed/added/deprecated items
	36	+ echo. xml to make Docutils-native XML files
	37	+ echo. pseudoxml to make pseudoxml-XML files for display purposes
	38	+ echo. linkcheck to check all external links for integrity
	39	+ echo. doctest to run all doctests embedded in the documentation if enabled
	40	+ goto end
	41	+)
	42	+
	43	+if "%1" == "clean" (
	44	+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
	45	+ del /q /s %BUILDDIR%\*
	46	+ goto end
	47	+)
	48	+
	49	+
	50	+%SPHINXBUILD% 2> nul
	51	+if errorlevel 9009 (
	52	+ echo.
	53	+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
	54	+ echo.installed, then set the SPHINXBUILD environment variable to point
	55	+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
	56	+ echo.may add the Sphinx directory to PATH.
	57	+ echo.
	58	+ echo.If you don't have Sphinx installed, grab it from
	59	+ echo.http://sphinx-doc.org/
	60	+ exit /b 1
	61	+)
	62	+
	63	+if "%1" == "html" (
	64	+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
	65	+ if errorlevel 1 exit /b 1
	66	+ echo.
	67	+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
	68	+ goto end
	69	+)
	70	+
	71	+if "%1" == "dirhtml" (
	72	+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
	73	+ if errorlevel 1 exit /b 1
	74	+ echo.
	75	+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
	76	+ goto end
	77	+)
	78	+
	79	+if "%1" == "singlehtml" (
	80	+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
	81	+ if errorlevel 1 exit /b 1
	82	+ echo.
	83	+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
	84	+ goto end
	85	+)
	86	+
	87	+if "%1" == "pickle" (
	88	+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
	89	+ if errorlevel 1 exit /b 1
	90	+ echo.
	91	+ echo.Build finished; now you can process the pickle files.
	92	+ goto end
	93	+)
	94	+
	95	+if "%1" == "json" (
	96	+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
	97	+ if errorlevel 1 exit /b 1
	98	+ echo.
	99	+ echo.Build finished; now you can process the JSON files.
	100	+ goto end
	101	+)
	102	+
	103	+if "%1" == "htmlhelp" (
	104	+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
	105	+ if errorlevel 1 exit /b 1
	106	+ echo.
	107	+ echo.Build finished; now you can run HTML Help Workshop with the ^
	108	+.hhp project file in %BUILDDIR%/htmlhelp.
	109	+ goto end
	110	+)
	111	+
	112	+if "%1" == "qthelp" (
	113	+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
	114	+ if errorlevel 1 exit /b 1
	115	+ echo.
	116	+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
	117	+.qhcp project file in %BUILDDIR%/qthelp, like this:
	118	+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ColabSoftwareDocumentation.qhcp
	119	+ echo.To view the help file:
	120	+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ColabSoftwareDocumentation.ghc
	121	+ goto end
	122	+)
	123	+
	124	+if "%1" == "devhelp" (
	125	+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
	126	+ if errorlevel 1 exit /b 1
	127	+ echo.
	128	+ echo.Build finished.
	129	+ goto end
	130	+)
	131	+
	132	+if "%1" == "epub" (
	133	+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
	134	+ if errorlevel 1 exit /b 1
	135	+ echo.
	136	+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
	137	+ goto end
	138	+)
	139	+
	140	+if "%1" == "latex" (
	141	+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
	142	+ if errorlevel 1 exit /b 1
	143	+ echo.
	144	+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
	145	+ goto end
	146	+)
	147	+
	148	+if "%1" == "latexpdf" (
	149	+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
	150	+ cd %BUILDDIR%/latex
	151	+ make all-pdf
	152	+ cd %BUILDDIR%/..
	153	+ echo.
	154	+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
	155	+ goto end
	156	+)
	157	+
	158	+if "%1" == "latexpdfja" (
	159	+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
	160	+ cd %BUILDDIR%/latex
	161	+ make all-pdf-ja
	162	+ cd %BUILDDIR%/..
	163	+ echo.
	164	+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
	165	+ goto end
	166	+)
	167	+
	168	+if "%1" == "text" (
	169	+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
	170	+ if errorlevel 1 exit /b 1
	171	+ echo.
	172	+ echo.Build finished. The text files are in %BUILDDIR%/text.
	173	+ goto end
	174	+)
	175	+
	176	+if "%1" == "man" (
	177	+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
	178	+ if errorlevel 1 exit /b 1
	179	+ echo.
	180	+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
	181	+ goto end
	182	+)
	183	+
	184	+if "%1" == "texinfo" (
	185	+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
	186	+ if errorlevel 1 exit /b 1
	187	+ echo.
	188	+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
	189	+ goto end
	190	+)
	191	+
	192	+if "%1" == "gettext" (
	193	+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
	194	+ if errorlevel 1 exit /b 1
	195	+ echo.
	196	+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
	197	+ goto end
	198	+)
	199	+
	200	+if "%1" == "changes" (
	201	+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
	202	+ if errorlevel 1 exit /b 1
	203	+ echo.
	204	+ echo.The overview file is in %BUILDDIR%/changes.
	205	+ goto end
	206	+)
	207	+
	208	+if "%1" == "linkcheck" (
	209	+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
	210	+ if errorlevel 1 exit /b 1
	211	+ echo.
	212	+ echo.Link check complete; look for any errors in the above output ^
	213	+or in %BUILDDIR%/linkcheck/output.txt.
	214	+ goto end
	215	+)
	216	+
	217	+if "%1" == "doctest" (
	218	+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
	219	+ if errorlevel 1 exit /b 1
	220	+ echo.
	221	+ echo.Testing of doctests in the sources finished, look at the ^
	222	+results in %BUILDDIR%/doctest/output.txt.
	223	+ goto end
	224	+)
	225	+
	226	+if "%1" == "xml" (
	227	+ %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
	228	+ if errorlevel 1 exit /b 1
	229	+ echo.
	230	+ echo.Build finished. The XML files are in %BUILDDIR%/xml.
	231	+ goto end
	232	+)
	233	+
	234	+if "%1" == "pseudoxml" (
	235	+ %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
	236	+ if errorlevel 1 exit /b 1
	237	+ echo.
	238	+ echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
	239	+ goto end
	240	+)
	241	+
	242	+:end
...	...
...	...	@@ -0,0 +1,174 @@
	1	+.. -- coding: utf-8 --
	2	+
	3	+.. highlight:: rest
	4	+
	5	+.. _ubuntu1004_install:
	6	+
	7	+Installation instructions for Ubuntu 10.04
	8	+==========================================
	9	+
	10	+.. contents :: :local:
	11	+
	12	+Install Solr and dependencies
	13	+-----------------------------
	14	+
	15	+* Install Java, tomcat, JDBC Postgres drivers (Ubuntu partner repositories must be enabled): ::
	16	+
	17	+ sudo apt-get install sun-java6-bin tomcat6 libpg-java
	18	+
	19	+* Download Solr 3.3 and extract it: ::
	20	+
	21	+ wget http://archive.apache.org/dist/lucene/solr/3.3.0/apache-solr-3.3.0.tgz
	22	+ tar xzf apache-solr-3.3.0.tgz
	23	+
	24	+* Create the directory ``/var/local/lib/solr/`` and give the right permissions: ::
	25	+
	26	+ sudo mkdir -p /var/local/lib/solr/
	27	+ sudo chown tomcat6:tomcat6 /var/local/lib/solr/
	28	+
	29	+* Copy the solr home example to ``/usr/local/share/``: ::
	30	+
	31	+ sudo cp -R apache-solr-3.3.0/example/solr /usr/local/share/
	32	+
	33	+* Create a folder for libs in the solr home: ::
	34	+
	35	+ sudo mkdir /usr/local/share/solr/lib/
	36	+
	37	+* Copy Solr libs to libs folder: ::
	38	+
	39	+ sudo cp apache-solr-3.3.0/dist/*.jar /usr/local/share/solr/lib/
	40	+
	41	+* Copy Solr distribution to solr home: ::
	42	+
	43	+ sudo cp apache-solr-3.3.0/dist/apache-solr-3.3.0.war /usr/local/share/solr/
	44	+
	45	+* Link the JDBC Postgres drivers into the Solr installation: ::
	46	+
	47	+ sudo ln -s /usr/share/java/postgresql-jdbc3-8.4.jar /usr/local/share/solr/lib/
	48	+
	49	+* Link configurations to ``/etc`` ::
	50	+
	51	+ sudo ln -s /usr/local/share/solr/conf/ /etc/solr
	52	+
	53	+* Copy the configuration files from this folder into ``/etc/solr/``
	54	+
	55	+* Link the ``solr-tomcat.xml`` file in the Tomcat configuration: ::
	56	+
	57	+ sudo ln -s /etc/solr/solr-tomcat.xml /etc/tomcat6/Catalina/localhost/solr.xml
	58	+
	59	+* Check ``data-config.xml`` to make sure all information to connect to the databases are right
	60	+
	61	+* Create a ``dataimport.properties`` on ``/etc/solr`` and give write access to ``tomcat6``: ::
	62	+
	63	+ sudo touch /etc/solr/dataimport.properties
	64	+ sudo chown tomcat6:tomcat6 /etc/solr/dataimport.properties
	65	+
	66	+* Restart tomcat: ::
	67	+
	68	+ sudo /etc/init.d/tomcat6 restart
	69	+
	70	+Install Colab and dependencies
	71	+------------------------------
	72	+
	73	+* Install Apache2 with WSGI support: ::
	74	+
	75	+ sudo apt-get install apache2 libapache2-mod-wsgi
	76	+
	77	+* Install dependencies to compile psycopg2: ::
	78	+
	79	+ sudo apt-get build-dep python-psycopg2
	80	+
	81	+* Install Python PIP and update it: ::
	82	+
	83	+ sudo apt-get install python-pip
	84	+ sudo pip install -U pip
	85	+
	86	+* Install python virtualenv: ::
	87	+
	88	+ sudo pip install virtualenv
	89	+
	90	+* Create a virtualenv for the deploy ::
	91	+
	92	+ sudo mkdir /usr/local/django/
	93	+ sudo virtualenv /usr/local/django/colab/
	94	+
	95	+* Download the colab ``src`` code: ::
	96	+
	97	+ sudo hg clone https://bitbucket.org/seocam/atu-colab /usr/local/src/colab/
	98	+
	99	+* Install the django site: ::
	100	+
	101	+ sudo pip install /usr/local/src/colab -E /usr/local/django/colab/
	102	+
	103	+* Configure your database settings in ``/usr/local/django/colab/lib/python2.6/site-packages/settings_local.py``
	104	+
	105	+* Enable the colab site on apache and reload it: ::
	106	+
	107	+ sudo ln -s /usr/local/django/colab/apache-site/colab /etc/apache2/sites-available
	108	+ sudo a2ensite colab
	109	+ sudo service apache2 restart
	110	+
	111	+Configuring server to send emails
	112	+----------------------------------
	113	+
	114	+* Install postfix and mailutils: ::
	115	+
	116	+ sudo apt-get install mailutils postfix
	117	+
	118	+* Update the file ``/etc/aliases`` adding users that should receive root's messages and run the update command: ::
	119	+
	120	+ sudo newaliases
	121	+
	122	+
	123	+Cron job to import emails
	124	+---------------------------
	125	+
	126	+* Install sshfs: ::
	127	+
	128	+ sudo apt-get install sshfs autofs
	129	+
	130	+* Create SSH keys. You should use a password but this tutorial won't cover it (if you use you will need to install and configure keychain process to be able to proceed): ::
	131	+
	132	+ sudo ssh-keygen
	133	+
	134	+* Copy the content of your key (``/root/.ssh/id_rsa.pub``) to the file ``/root/.ssh/authorized_keys`` on the mailinglist server.
	135	+
	136	+* Append the following content to /etc/auto.master file: ::
	137	+
	138	+ sudo /usr/local/django/colab/mnt /usr/local/django/colab/autofs/listas --timeout=600,--ghost
	139	+
	140	+* Restart autofs: ::
	141	+
	142	+ service autofs restart
	143	+
	144	+* Link cron script into ``/etc/cron.d/`` folder: ::
	145	+
	146	+ ln -s /usr/local/django/colab/cron.d/colab_import_emails /etc/cron.d/
	147	+
	148	+* From now on the emails should be imported every minute
	149	+
	150	+
	151	+Cron job to reindex Solr
	152	+-------------------------
	153	+
	154	+* Install wget: ::
	155	+
	156	+ sudo apt-get install wget
	157	+
	158	+* Link cron script into ``/etc/cron.d/`` folder: ::
	159	+
	160	+ sudo ln -s /usr/local/django/colab/cron.d/colab_solr_reindex /etc/cron.d/
	161	+
	162	+* From now on delta reindex should run every 10 minutes and full reindex once a day.
	163	+
	164	+
	165	+Updating an installed version
	166	+------------------------------
	167	+
	168	+* Update the source code: ::
	169	+
	170	+ sudo cd /usr/local/src/colab/
	171	+ sudo hg pull
	172	+ sudo hg up
	173	+ sudo pip install /usr/local/src/colab/ -E /usr/local/django/colab/ -U
	174	+ sudo service apache2 restart
...	...