# HG changeset patch # User Damien Correia # Date 1523279626 -7200 # Node ID d2871f43481836e90e774cf7f5c1093dd4123fdd # Parent e7207459c42970cca61d5991624a0b458487b984# Parent a9a7701fdf5c66796ebda10a6224cad83d27dd88 Update of the auto generated doc diff -r e7207459c429 -r d2871f434818 src/source/alchemy/pyams_alchemy.interfaces.rst --- a/src/source/alchemy/pyams_alchemy.interfaces.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_alchemy\.interfaces package -================================== - -Module contents -+++++++++++++++ - -.. automodule:: pyams_alchemy.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/alchemy/pyams_alchemy.rst --- a/src/source/alchemy/pyams_alchemy.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,91 +0,0 @@ -.. _pyams_alchemy: - -PyAMS SQLAlchemy integration -============================ - -*pyams_alchemy* package is a small package which can be used to make SQLAlchemy integration more simple. - -The main goal of *pyams_alchemy* package is to define the :class:`pyams_alchemy.engine.AlchemyEngineUtility` class: -this class can be stored persistently into PyAMS local site manager (see :ref:`site`) to store settings of an -SQLAlchemy engine; on user request, the :func:`pyams_alchemy.engine.get_user_session` function can be used to get -access to a new SQLAlchemy engine session matching these settings which will to be bound to current Pyramid's -transaction. - - -Dynamic schema names -++++++++++++++++++++ - -Some times you may have to be able to setup, for a given table, a schema name which is not static but can be dynamic -through a configuration option. - -This can be done easily with the help of the :class:`pyams_alchemy.mixin.DynamicSchemaMixin` which you can inherit from -in any SQLAlchemy table subclass. - -When this is done, the schema name can be defined into Pyramid's configuration file into a setting which is called -*pyams_alchemy:{module_name}.{class_name}.schema*; for example like in -*pyams_alchemy:pyams_content.package.TableName.schema*. If not specified, the table's schema name can be defined in a -classic *__schema__* table's attribute. - - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_alchemy - :members: - :undoc-members: - :show-inheritance: - - -Submodules -++++++++++ - -pyams\_alchemy\.engine module ------------------------------ - -.. automodule:: pyams_alchemy.engine - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.loader module ------------------------------ - -.. automodule:: pyams_alchemy.loader - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.metaconfigure module ------------------------------------- - -.. automodule:: pyams_alchemy.metaconfigure - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.metadirectives module -------------------------------------- - -.. automodule:: pyams_alchemy.metadirectives - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.mixin module ----------------------------- - -.. automodule:: pyams_alchemy.mixin - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_alchemy.interfaces - pyams_alchemy.tests - pyams_alchemy.zmi diff -r e7207459c429 -r d2871f434818 src/source/alchemy/pyams_alchemy.tests.rst --- a/src/source/alchemy/pyams_alchemy.tests.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_alchemy\.tests package -============================= - -Submodules -++++++++++ - -pyams\_alchemy\.tests\.test\_utilsdocs module ---------------------------------------------- - -.. automodule:: pyams_alchemy.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_alchemy\.tests\.test\_utilsdocstrings module ---------------------------------------------------- - -.. automodule:: pyams_alchemy.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_alchemy.tests - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/alchemy/pyams_alchemy.zmi.rst --- a/src/source/alchemy/pyams_alchemy.zmi.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_alchemy\.zmi package -=========================== - -Submodules -++++++++++ - -pyams\_alchemy\.zmi\.engine module ----------------------------------- - -.. automodule:: pyams_alchemy.zmi.engine - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_alchemy.zmi - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/cache/pyams_cache.handler.rst --- a/src/source/cache/pyams_cache.handler.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,31 +0,0 @@ -pyams\_cache\.handler package -============================= - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_cache.handler - :members: - :undoc-members: - :show-inheritance: - - -Submodules -++++++++++ - -pyams\_cache\.handler\.memcached module ---------------------------------------- - -.. automodule:: pyams_cache.handler.memcached - :members: - :undoc-members: - :show-inheritance: - -pyams\_cache\.handler\.redis module ------------------------------------ - -.. automodule:: pyams_cache.handler.redis - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/cache/pyams_cache.interfaces.rst --- a/src/source/cache/pyams_cache.interfaces.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,11 +0,0 @@ -pyams\_cache\.interfaces package -================================ - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_cache.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/cache/pyams_cache.rst --- a/src/source/cache/pyams_cache.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,51 +0,0 @@ -.. _pyams_cache: - -PyAMS cache management -====================== - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_cache - :members: - :undoc-members: - :show-inheritance: - - -Submodules -++++++++++ - -pyams\_cache\.beaker module ---------------------------- - -.. automodule:: pyams_cache.beaker - :members: - :undoc-members: - :show-inheritance: - -pyams\_cache\.cache module --------------------------- - -.. automodule:: pyams_cache.cache - :members: - :undoc-members: - :show-inheritance: - -pyams\_cache\.include module ----------------------------- - -.. automodule:: pyams_cache.include - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_cache.handler - pyams_cache.interfaces - pyams_cache.tests diff -r e7207459c429 -r d2871f434818 src/source/cache/pyams_cache.tests.rst --- a/src/source/cache/pyams_cache.tests.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,31 +0,0 @@ -pyams\_cache\.tests package -=========================== - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_cache.tests - :members: - :undoc-members: - :show-inheritance: - - -Submodules -++++++++++ - -pyams\_cache\.tests\.test\_utilsdocs module -------------------------------------------- - -.. automodule:: pyams_cache.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_cache\.tests\.test\_utilsdocstrings module -------------------------------------------------- - -.. automodule:: pyams_cache.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/catalogue/pyams_catalog.interfaces.rst --- a/src/source/catalogue/pyams_catalog.interfaces.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_catalog\.interfaces package -================================== - -Module contents ---------------- - -.. automodule:: pyams_catalog.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/catalogue/pyams_catalog.rst --- a/src/source/catalogue/pyams_catalog.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,75 +0,0 @@ -.. _pyams_catalog: - -PyAMS catalog -============= - - -Module contents -+++++++++++++++ - -.. automodule:: pyams_catalog - :members: - :undoc-members: - :show-inheritance: - - -Subpackages -+++++++++++ - -.. toctree:: - - pyams_catalog.interfaces - pyams_catalog.tests - pyams_catalog.zmi - - -Submodules -++++++++++ - -pyams\_catalog\.include module ------------------------------- - -.. automodule:: pyams_catalog.include - :members: - :undoc-members: - :show-inheritance: - -pyams\_catalog\.index module ----------------------------- - -.. automodule:: pyams_catalog.index - :members: - :undoc-members: - :show-inheritance: - -pyams\_catalog\.nltk module ---------------------------- - -.. automodule:: pyams_catalog.nltk - :members: - :undoc-members: - :show-inheritance: - -pyams\_catalog\.query module ----------------------------- - -.. automodule:: pyams_catalog.query - :members: - :undoc-members: - :show-inheritance: - -pyams\_catalog\.site module ---------------------------- - -.. automodule:: pyams_catalog.site - :members: - :undoc-members: - :show-inheritance: - -pyams\_catalog\.utils module ----------------------------- - -.. automodule:: pyams_catalog.utils - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/catalogue/pyams_catalog.tests.rst --- a/src/source/catalogue/pyams_catalog.tests.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_catalog\.tests package -============================= - -Submodules ----------- - -pyams\_catalog\.tests\.test\_utilsdocs module ---------------------------------------------- - -.. automodule:: pyams_catalog.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_catalog\.tests\.test\_utilsdocstrings module ---------------------------------------------------- - -.. automodule:: pyams_catalog.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_catalog.tests - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/catalogue/pyams_catalog.zmi.rst --- a/src/source/catalogue/pyams_catalog.zmi.rst Thu Apr 05 14:35:02 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_catalog\.zmi package -=========================== - -Submodules ----------- - -pyams\_catalog\.zmi\.catalog module ------------------------------------ - -.. automodule:: pyams_catalog.zmi.catalog - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_catalog.zmi - :members: - :undoc-members: - :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_alchemy/pyams_alchemy.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_alchemy/pyams_alchemy.interfaces.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,10 @@ +pyams\_alchemy\.interfaces package +================================== + +Module contents +--------------- + +.. automodule:: pyams_alchemy.interfaces + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_alchemy/pyams_alchemy.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_alchemy/pyams_alchemy.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,91 @@ +.. _pyams_alchemy: + +PyAMS SQLAlchemy integration +============================ + +*pyams_alchemy* package is a small package which can be used to make SQLAlchemy integration more simple. + +The main goal of *pyams_alchemy* package is to define the :class:`pyams_alchemy.engine.AlchemyEngineUtility` class: +this class can be stored persistently into PyAMS local site manager (see :ref:`site`) to store settings of an +SQLAlchemy engine; on user request, the :func:`pyams_alchemy.engine.get_user_session` function can be used to get +access to a new SQLAlchemy engine session matching these settings which will to be bound to current Pyramid's +transaction. + + +Dynamic schema names +++++++++++++++++++++ + +Some times you may have to be able to setup, for a given table, a schema name which is not static but can be dynamic +through a configuration option. + +This can be done easily with the help of the :class:`pyams_alchemy.mixin.DynamicSchemaMixin` which you can inherit from +in any SQLAlchemy table subclass. + +When this is done, the schema name can be defined into Pyramid's configuration file into a setting which is called +*pyams_alchemy:{module_name}.{class_name}.schema*; for example like in +*pyams_alchemy:pyams_content.package.TableName.schema*. If not specified, the table's schema name can be defined in a +classic *__schema__* table's attribute. + + + +Module contents ++++++++++++++++ + +.. automodule:: pyams_alchemy + :members: + :undoc-members: + :show-inheritance: + + +Submodules +++++++++++ + +pyams\_alchemy\.engine module +----------------------------- + +.. automodule:: pyams_alchemy.engine + :members: + :undoc-members: + :show-inheritance: + +pyams\_alchemy\.loader module +----------------------------- + +.. automodule:: pyams_alchemy.loader + :members: + :undoc-members: + :show-inheritance: + +pyams\_alchemy\.metaconfigure module +------------------------------------ + +.. automodule:: pyams_alchemy.metaconfigure + :members: + :undoc-members: + :show-inheritance: + +pyams\_alchemy\.metadirectives module +------------------------------------- + +.. automodule:: pyams_alchemy.metadirectives + :members: + :undoc-members: + :show-inheritance: + +pyams\_alchemy\.mixin module +---------------------------- + +.. automodule:: pyams_alchemy.mixin + :members: + :undoc-members: + :show-inheritance: + + +Subpackages ++++++++++++ + +.. toctree:: + + pyams_alchemy.interfaces + pyams_alchemy.tests + pyams_alchemy.zmi diff -r e7207459c429 -r d2871f434818 src/source/pyams_alchemy/pyams_alchemy.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_alchemy/pyams_alchemy.tests.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,30 @@ +pyams\_alchemy\.tests package +============================= + +Submodules +---------- + +pyams\_alchemy\.tests\.test\_utilsdocs module +--------------------------------------------- + +.. automodule:: pyams_alchemy.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams\_alchemy\.tests\.test\_utilsdocstrings module +--------------------------------------------------- + +.. automodule:: pyams_alchemy.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_alchemy.tests + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_alchemy/pyams_alchemy.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_alchemy/pyams_alchemy.zmi.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,22 @@ +pyams\_alchemy\.zmi package +=========================== + +Submodules +---------- + +pyams\_alchemy\.zmi\.engine module +---------------------------------- + +.. automodule:: pyams_alchemy.zmi.engine + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_alchemy.zmi + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_cache/pyams_cache.handler.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_cache/pyams_cache.handler.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,31 @@ +pyams\_cache\.handler package +============================= + + +Module contents ++++++++++++++++ + +.. automodule:: pyams_cache.handler + :members: + :undoc-members: + :show-inheritance: + + +Submodules +++++++++++ + +pyams\_cache\.handler\.memcached module +--------------------------------------- + +.. automodule:: pyams_cache.handler.memcached + :members: + :undoc-members: + :show-inheritance: + +pyams\_cache\.handler\.redis module +----------------------------------- + +.. automodule:: pyams_cache.handler.redis + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_cache/pyams_cache.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_cache/pyams_cache.interfaces.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,11 @@ +pyams\_cache\.interfaces package +================================ + + +Module contents ++++++++++++++++ + +.. automodule:: pyams_cache.interfaces + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_cache/pyams_cache.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_cache/pyams_cache.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,51 @@ +.. _pyams_cache: + +PyAMS cache management +====================== + + +Module contents ++++++++++++++++ + +.. automodule:: pyams_cache + :members: + :undoc-members: + :show-inheritance: + + +Submodules +++++++++++ + +pyams\_cache\.beaker module +--------------------------- + +.. automodule:: pyams_cache.beaker + :members: + :undoc-members: + :show-inheritance: + +pyams\_cache\.cache module +-------------------------- + +.. automodule:: pyams_cache.cache + :members: + :undoc-members: + :show-inheritance: + +pyams\_cache\.include module +---------------------------- + +.. automodule:: pyams_cache.include + :members: + :undoc-members: + :show-inheritance: + + +Subpackages ++++++++++++ + +.. toctree:: + + pyams_cache.handler + pyams_cache.interfaces + pyams_cache.tests diff -r e7207459c429 -r d2871f434818 src/source/pyams_cache/pyams_cache.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_cache/pyams_cache.tests.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,31 @@ +pyams\_cache\.tests package +=========================== + + +Module contents ++++++++++++++++ + +.. automodule:: pyams_cache.tests + :members: + :undoc-members: + :show-inheritance: + + +Submodules +++++++++++ + +pyams\_cache\.tests\.test\_utilsdocs module +------------------------------------------- + +.. automodule:: pyams_cache.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams\_cache\.tests\.test\_utilsdocstrings module +------------------------------------------------- + +.. automodule:: pyams_cache.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_catalog/pyams_catalog.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_catalog/pyams_catalog.interfaces.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,10 @@ +pyams\_catalog\.interfaces package +================================== + +Module contents +--------------- + +.. automodule:: pyams_catalog.interfaces + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_catalog/pyams_catalog.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_catalog/pyams_catalog.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,75 @@ +.. _pyams_catalog: + +PyAMS catalog +============= + + +Module contents ++++++++++++++++ + +.. automodule:: pyams_catalog + :members: + :undoc-members: + :show-inheritance: + + +Subpackages ++++++++++++ + +.. toctree:: + + pyams_catalog.interfaces + pyams_catalog.tests + pyams_catalog.zmi + + +Submodules +++++++++++ + +pyams\_catalog\.include module +------------------------------ + +.. automodule:: pyams_catalog.include + :members: + :undoc-members: + :show-inheritance: + +pyams\_catalog\.index module +---------------------------- + +.. automodule:: pyams_catalog.index + :members: + :undoc-members: + :show-inheritance: + +pyams\_catalog\.nltk module +--------------------------- + +.. automodule:: pyams_catalog.nltk + :members: + :undoc-members: + :show-inheritance: + +pyams\_catalog\.query module +---------------------------- + +.. automodule:: pyams_catalog.query + :members: + :undoc-members: + :show-inheritance: + +pyams\_catalog\.site module +--------------------------- + +.. automodule:: pyams_catalog.site + :members: + :undoc-members: + :show-inheritance: + +pyams\_catalog\.utils module +---------------------------- + +.. automodule:: pyams_catalog.utils + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_catalog/pyams_catalog.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_catalog/pyams_catalog.tests.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,30 @@ +pyams\_catalog\.tests package +============================= + +Submodules +---------- + +pyams\_catalog\.tests\.test\_utilsdocs module +--------------------------------------------- + +.. automodule:: pyams_catalog.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams\_catalog\.tests\.test\_utilsdocstrings module +--------------------------------------------------- + +.. automodule:: pyams_catalog.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_catalog.tests + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_catalog/pyams_catalog.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_catalog/pyams_catalog.zmi.rst Mon Apr 09 15:13:46 2018 +0200 @@ -0,0 +1,22 @@ +pyams\_catalog\.zmi package +=========================== + +Submodules +---------- + +pyams\_catalog\.zmi\.catalog module +----------------------------------- + +.. automodule:: pyams_catalog.zmi.catalog + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_catalog.zmi + :members: + :undoc-members: + :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.component.paragraph.interfaces.rst --- a/src/source/pyams_content/pyams_content.component.paragraph.interfaces.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.component.paragraph.interfaces.rst Mon Apr 09 15:13:46 2018 +0200 @@ -4,6 +4,22 @@ Submodules ---------- +pyams\_content\.component\.paragraph\.interfaces\.contact module +---------------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.contact + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\.component\.paragraph\.interfaces\.frame module +-------------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.frame + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.component\.paragraph\.interfaces\.header module --------------------------------------------------------------- @@ -20,6 +36,38 @@ :undoc-members: :show-inheritance: +pyams\_content\.component\.paragraph\.interfaces\.keypoint module +----------------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.keypoint + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\.component\.paragraph\.interfaces\.milestone module +------------------------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.interfaces.milestone + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\.component\.paragraph\.interfaces\.pictogram module +------------------------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.interfaces.pictogram + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\.component\.paragraph\.interfaces\.verbatim module +----------------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.verbatim + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.component\.paragraph\.interfaces\.video module -------------------------------------------------------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.component.paragraph.rst --- a/src/source/pyams_content/pyams_content.component.paragraph.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.component.paragraph.rst Mon Apr 09 15:13:46 2018 +0200 @@ -12,6 +12,14 @@ Submodules ---------- +pyams\_content\.component\.paragraph\.contact module +---------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.contact + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.component\.paragraph\.container module ------------------------------------------------------ @@ -20,6 +28,14 @@ :undoc-members: :show-inheritance: +pyams\_content\.component\.paragraph\.frame module +-------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.frame + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.component\.paragraph\.header module --------------------------------------------------- @@ -36,6 +52,38 @@ :undoc-members: :show-inheritance: +pyams\_content\.component\.paragraph\.keypoint module +----------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.keypoint + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\.component\.paragraph\.milestone module +------------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.milestone + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\.component\.paragraph\.pictogram module +------------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.pictogram + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\.component\.paragraph\.verbatim module +----------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.verbatim + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.component\.paragraph\.video module -------------------------------------------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.component.paragraph.zmi.rst --- a/src/source/pyams_content/pyams_content.component.paragraph.zmi.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.component.paragraph.zmi.rst Mon Apr 09 15:13:46 2018 +0200 @@ -4,6 +4,14 @@ Submodules ---------- +pyams\_content\.component\.paragraph\.zmi\.contact module +--------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.contact + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.component\.paragraph\.zmi\.container module ----------------------------------------------------------- @@ -12,6 +20,14 @@ :undoc-members: :show-inheritance: +pyams\_content\.component\.paragraph\.zmi\.frame module +------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.frame + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.component\.paragraph\.zmi\.header module -------------------------------------------------------- @@ -36,6 +52,30 @@ :undoc-members: :show-inheritance: +pyams\_content\.component\.paragraph\.zmi\.keypoint module +---------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.keypoint + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\.component\.paragraph\.zmi\.milestone module +----------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.milestone + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\.component\.paragraph\.zmi\.pictogram module +----------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.pictogram + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.component\.paragraph\.zmi\.preview module --------------------------------------------------------- @@ -44,6 +84,14 @@ :undoc-members: :show-inheritance: +pyams\_content\.component\.paragraph\.zmi\.verbatim module +---------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.verbatim + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.component\.paragraph\.zmi\.video module ------------------------------------------------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.component.rst --- a/src/source/pyams_content/pyams_content.component.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.component.rst Mon Apr 09 15:13:46 2018 +0200 @@ -14,6 +14,7 @@ pyams_content.component.media pyams_content.component.paragraph pyams_content.component.theme + pyams_content.component.video Module contents --------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.features.rst --- a/src/source/pyams_content/pyams_content.features.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.features.rst Mon Apr 09 15:13:46 2018 +0200 @@ -6,8 +6,10 @@ .. toctree:: + pyams_content.features.alert pyams_content.features.checker pyams_content.features.preview + pyams_content.features.renderer pyams_content.features.review Module contents diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.rst --- a/src/source/pyams_content/pyams_content.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_content: - pyams\_content package ====================== @@ -9,15 +7,14 @@ .. toctree:: pyams_content.component - pyams_content.features pyams_content.generations pyams_content.interfaces pyams_content.profile + pyams_content.reference pyams_content.root pyams_content.scripts pyams_content.shared pyams_content.skin - pyams_content.tests pyams_content.workflow Submodules diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.shared.common.rst --- a/src/source/pyams_content/pyams_content.shared.common.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.shared.common.rst Mon Apr 09 15:13:46 2018 +0200 @@ -20,14 +20,6 @@ :undoc-members: :show-inheritance: -pyams\_content\.shared\.common\.review module ---------------------------------------------- - -.. automodule:: pyams_content.shared.common.review - :members: - :undoc-members: - :show-inheritance: - pyams\_content\.shared\.common\.security module ----------------------------------------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.shared.form.zmi.rst --- a/src/source/pyams_content/pyams_content.shared.form.zmi.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.shared.form.zmi.rst Mon Apr 09 15:13:46 2018 +0200 @@ -12,18 +12,18 @@ :undoc-members: :show-inheritance: -pyams\_content\.shared\.form\.zmi\.preview module -------------------------------------------------- +pyams\_content\.shared\.form\.zmi\.properties module +---------------------------------------------------- -.. automodule:: pyams_content.shared.form.zmi.preview +.. automodule:: pyams_content.shared.form.zmi.properties :members: :undoc-members: :show-inheritance: -pyams\_content\.shared\.form\.zmi\.properties module ----------------------------------------------------- +pyams\_content\.shared\.form\.zmi\.render module +------------------------------------------------ -.. automodule:: pyams_content.shared.form.zmi.properties +.. automodule:: pyams_content.shared.form.zmi.render :members: :undoc-members: :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.shared.imagemap.zmi.rst --- a/src/source/pyams_content/pyams_content.shared.imagemap.zmi.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.shared.imagemap.zmi.rst Mon Apr 09 15:13:46 2018 +0200 @@ -28,18 +28,18 @@ :undoc-members: :show-inheritance: -pyams\_content\.shared\.imagemap\.zmi\.preview module ------------------------------------------------------ +pyams\_content\.shared\.imagemap\.zmi\.properties module +-------------------------------------------------------- -.. automodule:: pyams_content.shared.imagemap.zmi.preview +.. automodule:: pyams_content.shared.imagemap.zmi.properties :members: :undoc-members: :show-inheritance: -pyams\_content\.shared\.imagemap\.zmi\.properties module --------------------------------------------------------- +pyams\_content\.shared\.imagemap\.zmi\.render module +---------------------------------------------------- -.. automodule:: pyams_content.shared.imagemap.zmi.properties +.. automodule:: pyams_content.shared.imagemap.zmi.render :members: :undoc-members: :show-inheritance: diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.shared.rst --- a/src/source/pyams_content/pyams_content.shared.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.shared.rst Mon Apr 09 15:13:46 2018 +0200 @@ -10,6 +10,7 @@ pyams_content.shared.common pyams_content.shared.form pyams_content.shared.imagemap + pyams_content.shared.logo pyams_content.shared.news pyams_content.shared.site pyams_content.shared.view diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.shared.view.zmi.rst --- a/src/source/pyams_content/pyams_content.shared.view.zmi.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.shared.view.zmi.rst Mon Apr 09 15:13:46 2018 +0200 @@ -4,14 +4,6 @@ Submodules ---------- -pyams\_content\.shared\.view\.zmi\.preview module -------------------------------------------------- - -.. automodule:: pyams_content.shared.view.zmi.preview - :members: - :undoc-members: - :show-inheritance: - pyams\_content\.shared\.view\.zmi\.properties module ---------------------------------------------------- @@ -28,6 +20,14 @@ :undoc-members: :show-inheritance: +pyams\_content\.shared\.view\.zmi\.render module +------------------------------------------------ + +.. automodule:: pyams_content.shared.view.zmi.render + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.shared\.view\.zmi\.theme module ----------------------------------------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.skin.rst --- a/src/source/pyams_content/pyams_content.skin.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.skin.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,17 +1,15 @@ pyams\_content\.skin package ============================ - Subpackages -+++++++++++ +----------- .. toctree:: pyams_content.skin.zmi - Submodules -++++++++++ +---------- pyams\_content\.skin\.routes module ----------------------------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_content/pyams_content.workflow.rst --- a/src/source/pyams_content/pyams_content.workflow.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content/pyams_content.workflow.rst Mon Apr 09 15:13:46 2018 +0200 @@ -11,6 +11,14 @@ Submodules ---------- +pyams\_content\.workflow\.basic module +-------------------------------------- + +.. automodule:: pyams_content.workflow.basic + :members: + :undoc-members: + :show-inheritance: + pyams\_content\.workflow\.interfaces module ------------------------------------------- @@ -19,14 +27,6 @@ :undoc-members: :show-inheritance: -pyams\_content\.workflow\.basic module --------------------------------------- - -.. automodule:: pyams_content.workflow.basic - :members: - :undoc-members: - :show-inheritance: - pyams\_content\.workflow\.notify module --------------------------------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_content_es/pyams_content_es.rst --- a/src/source/pyams_content_es/pyams_content_es.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_content_es/pyams_content_es.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_content_es: - pyams\_content\_es package ========================== @@ -11,7 +9,6 @@ pyams_content_es.component pyams_content_es.interfaces pyams_content_es.scripts - pyams_content_es.tests pyams_content_es.zmi Submodules diff -r e7207459c429 -r d2871f434818 src/source/pyams_gis/pyams_gis.rst --- a/src/source/pyams_gis/pyams_gis.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_gis/pyams_gis.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_gis: - pyams\_gis package ================== @@ -10,7 +8,6 @@ pyams_gis.interfaces pyams_gis.rpc - pyams_gis.tests pyams_gis.widget pyams_gis.zmi @@ -73,6 +70,14 @@ :undoc-members: :show-inheritance: +pyams\_gis\.transform module +---------------------------- + +.. automodule:: pyams_gis.transform + :members: + :undoc-members: + :show-inheritance: + pyams\_gis\.utility module -------------------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_ldap/pyams_ldap.rst --- a/src/source/pyams_ldap/pyams_ldap.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_ldap/pyams_ldap.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_ldap: - pyams\_ldap package =================== @@ -9,7 +7,6 @@ .. toctree:: pyams_ldap.interfaces - pyams_ldap.tests pyams_ldap.zmi Submodules diff -r e7207459c429 -r d2871f434818 src/source/pyams_mail/pyams_mail.rst --- a/src/source/pyams_mail/pyams_mail.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_mail/pyams_mail.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_mail: - pyams\_mail package =================== @@ -9,7 +7,6 @@ .. toctree:: pyams_mail.interfaces - pyams_mail.tests Submodules ---------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_media/pyams_media.rst --- a/src/source/pyams_media/pyams_media.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_media/pyams_media.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_media: - pyams\_media package ==================== @@ -10,7 +8,6 @@ pyams_media.interfaces pyams_media.skin - pyams_media.tests pyams_media.zmi Submodules diff -r e7207459c429 -r d2871f434818 src/source/pyams_portal/pyams_portal.portlets.content.rst --- a/src/source/pyams_portal/pyams_portal.portlets.content.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_portal/pyams_portal.portlets.content.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,6 +1,13 @@ pyams\_portal\.portlets\.content package ======================================== +Subpackages +----------- + +.. toctree:: + + pyams_portal.portlets.content.zmi + Submodules ---------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_portal/pyams_portal.portlets.image.rst --- a/src/source/pyams_portal/pyams_portal.portlets.image.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_portal/pyams_portal.portlets.image.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,6 +1,13 @@ pyams\_portal\.portlets\.image package ====================================== +Subpackages +----------- + +.. toctree:: + + pyams_portal.portlets.image.zmi + Submodules ---------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_portal/pyams_portal.portlets.rst --- a/src/source/pyams_portal/pyams_portal.portlets.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_portal/pyams_portal.portlets.rst Mon Apr 09 15:13:46 2018 +0200 @@ -7,6 +7,7 @@ .. toctree:: pyams_portal.portlets.content + pyams_portal.portlets.html pyams_portal.portlets.image Module contents diff -r e7207459c429 -r d2871f434818 src/source/pyams_portal/pyams_portal.rst --- a/src/source/pyams_portal/pyams_portal.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_portal/pyams_portal.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_portal: - pyams\_portal package ===================== @@ -10,7 +8,6 @@ pyams_portal.interfaces pyams_portal.portlets - pyams_portal.tests pyams_portal.zmi Submodules diff -r e7207459c429 -r d2871f434818 src/source/pyams_portal/pyams_portal.zmi.rst --- a/src/source/pyams_portal/pyams_portal.zmi.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_portal/pyams_portal.zmi.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,13 +1,6 @@ pyams\_portal\.zmi package ========================== -Subpackages ------------ - -.. toctree:: - - pyams_portal.zmi.portlets - Submodules ---------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_scheduler/pyams_scheduler.rst --- a/src/source/pyams_scheduler/pyams_scheduler.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_scheduler/pyams_scheduler.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_scheduler: - pyams\_scheduler package ======================== @@ -9,7 +7,6 @@ .. toctree:: pyams_scheduler.interfaces - pyams_scheduler.tests pyams_scheduler.zmi Submodules diff -r e7207459c429 -r d2871f434818 src/source/pyams_sequence/pyams_sequence.rst --- a/src/source/pyams_sequence/pyams_sequence.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_sequence/pyams_sequence.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_sequence: - pyams\_sequence package ======================= @@ -10,7 +8,6 @@ pyams_sequence.interfaces pyams_sequence.rpc - pyams_sequence.tests pyams_sequence.widget pyams_sequence.zmi diff -r e7207459c429 -r d2871f434818 src/source/pyams_workflow/pyams_workflow.rst --- a/src/source/pyams_workflow/pyams_workflow.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_workflow/pyams_workflow.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_workflow: - pyams\_workflow package ======================= @@ -9,7 +7,6 @@ .. toctree:: pyams_workflow.interfaces - pyams_workflow.tests pyams_workflow.zmi Submodules diff -r e7207459c429 -r d2871f434818 src/source/pyams_workflow/pyams_workflow.zmi.rst --- a/src/source/pyams_workflow/pyams_workflow.zmi.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_workflow/pyams_workflow.zmi.rst Mon Apr 09 15:13:46 2018 +0200 @@ -35,6 +35,7 @@ :undoc-members: :show-inheritance: + Module contents --------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_workflow/pyams_workflow.zmi.viewlet.rst --- a/src/source/pyams_workflow/pyams_workflow.zmi.viewlet.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_workflow/pyams_workflow.zmi.viewlet.rst Mon Apr 09 15:13:46 2018 +0200 @@ -4,6 +4,14 @@ Submodules ---------- +pyams\_workflow\.zmi\.viewlet\.transitions module +------------------------------------------------- + +.. automodule:: pyams_workflow.zmi.viewlet.transitions + :members: + :undoc-members: + :show-inheritance: + pyams\_workflow\.zmi\.viewlet\.versions module ---------------------------------------------- @@ -12,14 +20,6 @@ :undoc-members: :show-inheritance: -pyams\_workflow\.zmi\.viewlet\.transitions module -------------------------------------------------- - -.. automodule:: pyams_workflow.zmi.viewlet.transitions - :members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff -r e7207459c429 -r d2871f434818 src/source/pyams_zmq/pyams_zmq.rst --- a/src/source/pyams_zmq/pyams_zmq.rst Thu Apr 05 14:35:02 2018 +0200 +++ b/src/source/pyams_zmq/pyams_zmq.rst Mon Apr 09 15:13:46 2018 +0200 @@ -1,5 +1,3 @@ -.. _pyams_zmq: - pyams\_zmq package ================== @@ -9,7 +7,6 @@ .. toctree:: pyams_zmq.interfaces - pyams_zmq.tests Submodules ----------