the docs folder shall be in the root folder for the easier build of documentation

.gitignore

@@ -7,3 +7,5 @@ openpiv/src/lib.c
 build/
 *.txt
 /setup.cfg
+openpiv/lib.so
+openpiv/process.so

INSTALL

@@ -15,6 +15,7 @@ The dependencies are:
 * `scipy <http://numpy.scipy.org/>`_
 * `numpy <http://www.scipy.org/>`_
 * `cython <http://cython.org/>`_
+* `scikit-image <http://scikit-image.org/>`_
 
 On all the platforms, the binary Enthought Python Distribution (EPD) is recommended. 
 Visit http://www.enthought.com
@@ -25,6 +26,33 @@ On a Linux platform installing these dependencies should be trick. Often, if not
 python is installed by default, while the other dependencies should appear in your package
 manager.
 
+/**
+Example of installation procedure on Ubuntu
+(tested for version 10.04 to 12.10)
+	*open a terminal & install modules
+sudo apt-get install python-pip
+sudo apt-get install python-setuptools python-dev build-essential
+sudo pip install numpy
+sudo pip install
+sudo apt-get install libatlas-base-dev gfortran
+sudo pip install scipy
+sudo pip install cython
+sudo apt-get install python-matplotlib
+pip install -U scikit-image
+	*you will need version 1.6.0 or later of the numpy module. 
+	*If pip cannot find the right version, easyinstall should work:
+         	sudo easyinstall numpy
+	*now download openpiv source code and move to the openpiv directory
+	*then install openpiv:
+sudo python setup.py install
+	*open a new terminal & test openpiv
+openpiv
+	*if you get an error such as "unknown module lib" try to logout or try to modify the PYTHONPATH variable by adding
+	      export PYTHONPATH=$PYTHONPATH:[path-to-openpiv-directory]  
+	to your ~/.bashrc file and then logout or:
+	 source ~/.bashrc
+**/
+
 How to install the dependencies on Windows
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 On Windows all these dependencies, as well as several other useful packages, can be installed

openpiv/docs/sphinx-docs/Makefile → docs/Makefile

@@ -5,14 +5,16 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = ../../../docs
 
 # 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
+.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"
@@ -29,6 +31,9 @@ help:
 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 	@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 "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
@@ -72,17 +77,17 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenPiv.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenPIV.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenPiv.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenPIV.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/OpenPiv"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenPiv"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/OpenPIV"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenPIV"
 	@echo "# devhelp"
 
 epub:
@@ -100,7 +105,7 @@ latex:
 latexpdf:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 	@echo "Running LaTeX files through pdflatex..."
-	make -C $(BUILDDIR)/latex all-pdf
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
 text:
@@ -113,6 +118,24 @@ 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

openpiv/docs/sphinx-docs/conf.py → docs/conf.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
-# OpenPiv documentation build configuration file, created by
-# sphinx-quickstart on Mon Apr 18 23:22:32 2011.
+# OpenPIV documentation build configuration file, created by
+# sphinx-quickstart on Tue Feb  4 13:18:21 2014.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -25,13 +25,11 @@
 
 # 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.pngmath', 'numpydoc', 'sphinx.ext.autosummary']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
-autosummary_generate = True
-
 # The suffix of source filenames.
 source_suffix = '.rst'
 
@@ -43,16 +41,16 @@
 
 # General information about the project.
 project = u'OpenPIV'
-copyright = u'2011, The OpenPIV Contributors'
+copyright = u'2014, OpenPIV group'
 
 # 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'
+version = '0.0.1'
 # The full version, including alpha/beta/rc tags.
-release = '1'
+release = '0.0.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -171,17 +169,22 @@
 
 # -- Options for LaTeX output --------------------------------------------------
 
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+#'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', 'OpenPIV.tex', u'OpenPIV Documentation',
-   u'The OpenPIV Contributors', 'manual'),
+   u'OpenPIV group', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -198,9 +201,6 @@
 # If true, show URL addresses after external links.
 #latex_show_urls = False
 
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
 # Documents to append as an appendix to all manuals.
 #latex_appendices = []
 
@@ -214,5 +214,29 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'openpiv', u'OpenPIV Documentation',
-     [u'The OpenPIV Contributors'], 1)
+     [u'OpenPIV group'], 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', 'OpenPIV', u'OpenPIV Documentation',
+   u'OpenPIV group', 'OpenPIV', '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'

openpiv/docs/sphinx-docs/index.rst → docs/index.rst

@@ -1,33 +1,34 @@
-.. OpenPiv documentation master file, created by
+.. OpenPIV documentation master file, created by
    sphinx-quickstart on Mon Apr 18 23:22:32 2011.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-OpenPiv: a python package for PIV image analysis.
+OpenPIV: a python package for PIV image analysis.
 =================================================
 
-OpenPiv is a effort of scientists to deliver a tool for the analysis of PIV images
+OpenPIV is a effort of scientists to deliver a tool for the analysis of PIV images
 using state-of-the-art algorithms. Openpiv is released under the 
 `GPL Licence <http://en.wikipedia.org/wiki/GNU_General_Public_License>`_,
 which means that the source code is freely available for users to study, copy, modify
 and improve. Because of its permissive licence, you are welcome to download and try 
-OpenPiv for whatever need you may have. Furthermore, you are encouraged to contribute
-to OpenPiv, with code, suggestions and critics.
+OpenPIV for whatever need you may have. Furthermore, you are encouraged to contribute
+to OpenPIV, with code, suggestions and critics.
 
-OpenPiv exists in three forms: Matlab, C++ and Python. This is the home page of the Python implementation.
+OpenPIV exists in three forms: Matlab, C++ and Python. This is the home page of the Python implementation.
 
 =========
 Contents:
 =========
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :titlesonly:
 
-   src/downloads_page
+
    src/installation_instruction
    src/developers
    src/tutorial
+   src/downloads_page
    src/api_reference
 
 Indices and tables