8 files changed, 414 insertions, 0 deletions
diff --git a/base_geoengine/doc/source/_static/_images/core_architecture.jpg b/base_geoengine/doc/source/_static/_images/core_architecture.jpg
new file mode 100644
index 0000000..326593d
--- /dev/null
+++ b/base_geoengine/doc/source/_static/_images/core_architecture.jpg
diff --git a/base_geoengine/doc/source/api_doc.rst b/base_geoengine/doc/source/api_doc.rst
new file mode 100644
index 0000000..56c5af9
--- /dev/null
+++ b/base_geoengine/doc/source/api_doc.rst
@@ -0,0 +1,63 @@
+======
+API
+======
+
+***********
+GeoColumns
+***********
+.. automodule:: base_geoengine.geo_field
+ :members:
+
+.. automodule:: base_geoengine.geo_point
+ :members:
+
+.. automodule:: base_geoengine.geo_line
+ :members:
+
+.. automodule:: base_geoengine.geo_multiline
+ :members:
+
+.. automodule:: base_geoengine.geo_polygon
+ :members:
+
+.. automodule:: base_geoengine.geo_multipolygon
+ :members:
+
+****************
+View Management
+****************
+
+.. automodule:: base_geoengine.geo_view
+ :members:
+
+.. automodule:: base_geoengine.geo_view.geo_raster_layer
+ :members:
+
+.. automodule:: base_geoengine.geo_view.geo_vector_layer
+ :members:
+
+.. automodule:: base_geoengine.geo_view.ir_view
+ :members:
+
+**************
+GEO ORM MODEL
+**************
+.. autoclass:: base_geoengine.geo_model.GeoModel
+ :members:
+
+******************
+GEO ORM OPERATORS
+******************
+
+.. automodule:: base_geoengine.geo_operators
+ :members:
+
+.. autoclass:: base_geoengine.geo_operators.GeoOperator
+ :members:
+
+***********
+GEO helper
+***********
+
+.. automodule:: base_geoengine.geo_helper.geo_convertion_helper
+ :members:
diff --git a/base_geoengine/doc/source/conf.py b/base_geoengine/doc/source/conf.py
new file mode 100644
index 0000000..e555802
--- /dev/null
+++ b/base_geoengine/doc/source/conf.py
@@ -0,0 +1,246 @@
+# flake8: noqa
+#
+# OpenERP GeoEngine documentation build configuration file, created by
+# sphinx-quickstart on Mon Mar  5 09:15:25 2012.
+#
+# 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 imp
+import os
+import sys
+
+import sphinx_bootstrap_theme
+
+# 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.
+
+
+odoo_root = "/home/travis/odoo-" + os.environ["VERSION"]
+sphinxodoo_root_path = os.path.abspath(odoo_root)
+sphinxodoo_addons_path = [
+    os.path.abspath(os.path.join(odoo_root, "openerp", "addons")),
+    os.path.abspath(os.path.join(odoo_root, "addons")),
+    os.path.abspath(os.environ["TRAVIS_BUILD_DIR"]),
+]
+geo_path = os.environ["TRAVIS_BUILD_DIR"]
+addons = [
+    x
+    for x in os.listdir(geo_path)
+    if not x.startswith(".") and os.path.isdir(os.path.join(geo_path, x))
+]
+sphinxodoo_addons = addons
+sys.path.append(os.environ["TRAVIS_BUILD_DIR"])
+# -- 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", "sphinxodoo.ext.autodoc"]
+
+# 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 = "Odoo Geospatial"
+copyright = "2015, Nicolas Bessi, Odoo Community Association (OCA)"
+
+# 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.3"
+# The full version, including alpha/beta/rc tags.
+release = "0.3"
+
+# 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 = "bootstrap"
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+# 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 = "OpenERPGeoEnginedoc"
+
+
+# -- 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",
+        "OpenERPGeoEngine.tex",
+        "Odoo Geospatial Documentation",
+        "Odoo Community Association (OCA), Nicolas Bessi",
+        "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
+
+# 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_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",
+        "openerpgeoengine",
+        "Odoo Geospatial Documentation",
+        ["Odoo Community Association (OCA), Nicolas Bessi"],
+        1,
+    )
+]
diff --git a/base_geoengine/doc/source/index.rst b/base_geoengine/doc/source/index.rst
new file mode 100644
index 0000000..44f6d7a
--- /dev/null
+++ b/base_geoengine/doc/source/index.rst
@@ -0,0 +1,31 @@
+.. OpenERP GeoEngine documentation master file, created by
+   sphinx-quickstart on Mon Mar  5 09:15:25 2012.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Odoo Geospatial's documentation
+==========================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   what_is_geoengine
+   prerequisite
+   installation
+   postgisify
+   api_doc
+
+   How to use GeoEngine
+   Modules presentations
+   API presentation
+   Manage your layer from client
+   Create a geocolumn from client
+
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/base_geoengine/doc/source/installation.rst b/base_geoengine/doc/source/installation.rst
new file mode 100644
index 0000000..1beaa90
--- /dev/null
+++ b/base_geoengine/doc/source/installation.rst
@@ -0,0 +1,12 @@
+=================
+Installation
+=================
+
+Once prerequisites are installed you still have to apply fixes pending to be merge in
+Odoo Core before being able to use it: ::
+
+    git pull origin pull/5620/head
+    git cherry-pick 676e4b8d
+
+This fix is already merged in the OCB (Odoo Community Backports) branch.
+If you are using it there is no need to install the fix yourself.
diff --git a/base_geoengine/doc/source/postgisify.rst b/base_geoengine/doc/source/postgisify.rst
new file mode 100644
index 0000000..8aaf6ec
--- /dev/null
+++ b/base_geoengine/doc/source/postgisify.rst
@@ -0,0 +1,16 @@
+*********************************
+Postgisify an exisiting database
+*********************************
+
+If you want to install the GeoEngine on an existing database you have two options.
+
+If you are using a PostgreSQL super user it should work out of the box.
+If you are using a standard user you have to connect to your database and run: ::
+
+  CREATE EXTENSION postgis
+  CREATE EXTENSION postgis_topology
+
+In order to test if the installation is sucessfull log into you database and::
+
+  SELECT * from GEOMETRY_COLUMNS;
+  SELECT * from spatial_ref_sys;
diff --git a/base_geoengine/doc/source/prerequisite.rst b/base_geoengine/doc/source/prerequisite.rst
new file mode 100644
index 0000000..416707f
--- /dev/null
+++ b/base_geoengine/doc/source/prerequisite.rst
@@ -0,0 +1,30 @@
+=================
+Prerequisites
+=================
+***************
+Python
+***************
+geojson:
+
+::
+
+ pip install geojson
+
+Shapely:
+
+::
+
+ pip install Shapely==1.2.13
+
+For Mac user: do not forget the following directive:
+
+::
+
+ ARCHFLAGS="-arch i386 -arch x86_64"
+
+
+***************
+PostGIS 2.0
+***************
+
+Please refer to `PostGIS installation directive <http://postgis.refractions.net/docs/>`_ or to your OS package system.
diff --git a/base_geoengine/doc/source/what_is_geoengine.rst b/base_geoengine/doc/source/what_is_geoengine.rst
new file mode 100644
index 0000000..cb64b8c
--- /dev/null
+++ b/base_geoengine/doc/source/what_is_geoengine.rst
@@ -0,0 +1,16 @@
+===================
+What is GeoEngine ?
+===================
+
+GeoEngine is an OpenERP module that adds spatial/GIS capabilites to OpenERP. It will allow you to :
+
+* Visualize and query your business information on map
+* Perform GeoBI and spatial query
+* Configure your spatial layers and spatial datasources
+* Extend OpenERP models with spatial columns
+
+GeoEngine relies on `OpenLayers <http://openlayers.org>`_ and `PostgGIS <http://postgis.refractions.net/>`_ technologies.
+
+Postgis is used to store spatial information in databases. OpenLayer is used to represent spatial data in other words to show maps. The GeoEngine module acts as a data provider and as an OpenLayers configurator. It also provides a complete extension to OpenERP ORM.
+
+.. image:: _static/_images/core_architecture.jpg