Update documentation

guewen · Jul 11, 2017 · 368ad1f · 368ad1f
1 parent eed6ed4
commit 368ad1f
Show file tree

Hide file tree

Showing 51 changed files with 495 additions and 1,143 deletions.
diff --git a/connector_magento/CHANGES.rst b/connector_magento/CHANGES.rst
diff --git a/connector_magento/components/core.py b/connector_magento/components/core.py
@@ -6,6 +6,10 @@
 
 
 class BaseMagentoConnectorComponent(AbstractComponent):
+    """ Base Magento Connector Component
+
+    All components of this connector should inherit from it.
+    """
 
     _name = 'base.magento.connector'
     _inherit = 'base.connector'

diff --git a/connector_magento/doc/api/api_backend.rst b/connector_magento/doc/api/api_backend.rst
diff --git a/connector_magento/doc/api/api_backend_adapter.rst b/connector_magento/doc/api/api_backend_adapter.rst
diff --git a/connector_magento/doc/api/api_binder.rst b/connector_magento/doc/api/api_binder.rst
diff --git a/connector_magento/doc/api/api_components.rst b/connector_magento/doc/api/api_components.rst
@@ -0,0 +1,77 @@
+.. _api-component:
+
+##########
+Components
+##########
+
+Components are the blocks allowing to build a flexible and
+well decoupled code. They are based on the ``component`` addon and the base
+components of the Connector.
+
+**************
+Core Component
+**************
+
+.. automodule:: odoo.addons.connector_magento.components.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+******************
+Magento Components
+******************
+
+Backend Adapter
+===============
+
+.. automodule:: odoo.addons.connector_magento.components.backend_adapter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Binder
+======
+
+.. automodule:: odoo.addons.connector_magento.components.binder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Deleter
+=======
+
+.. automodule:: odoo.addons.connector_magento.components.deleter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Exporter
+========
+
+.. automodule:: odoo.addons.connector_magento.components.exporter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Importer
+========
+
+.. automodule:: odoo.addons.connector_magento.components.importer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+Mapper
+======
+
+.. automodule:: odoo.addons.connector_magento.components.mapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/connector_magento/doc/api/api_connector.rst b/connector_magento/doc/api/api_connector.rst
diff --git a/connector_magento/doc/api/api_consumer.rst b/connector_magento/doc/api/api_consumer.rst
diff --git a/connector_magento/doc/api/api_delivery.rst b/connector_magento/doc/api/api_delivery.rst
diff --git a/connector_magento/doc/api/api_exception.rst b/connector_magento/doc/api/api_exception.rst
@@ -1,9 +1,10 @@
+.. _api-exception:
+
+##########
 Exceptions
-==========
+##########
 
-.. automodule:: openerp.addons.connector_magento.exception
+.. automodule:: odoo.addons.connector_magento.exception
    :members:
    :undoc-members:
    :show-inheritance:
-
-
diff --git a/connector_magento/doc/api/api_invoice.rst b/connector_magento/doc/api/api_invoice.rst
diff --git a/connector_magento/doc/api/api_magento_model.rst b/connector_magento/doc/api/api_magento_model.rst