# HG changeset patch # User Thierry Florac # Date 1544081050 -3600 # Node ID b2be9a32f3fcfd0bddcaad99c3b1f8221813baf9 Rebuild repository after corruption diff -r 000000000000 -r b2be9a32f3fc .hgignore --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.hgignore Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,21 @@ + +syntax: regexp +^develop-eggs$ +syntax: regexp +^parts$ +syntax: regexp +^bin$ +syntax: regexp +^\.installed\.cfg$ +syntax: regexp +^\.settings$ +syntax: regexp +^build$ +syntax: regexp +^dist$ +syntax: regexp +^\.idea$ +syntax: regexp +.*\.pyc$ +syntax: regexp +^src\/build$ diff -r 000000000000 -r b2be9a32f3fc bootstrap.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bootstrap.py Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,210 @@ +############################################################################## +# +# Copyright (c) 2006 Zope Foundation and Contributors. +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# +############################################################################## +"""Bootstrap a buildout-based project + +Simply run this script in a directory containing a buildout.cfg. +The script accepts buildout command-line options, so you can +use the -c option to specify an alternate configuration file. +""" + +import os +import shutil +import sys +import tempfile + +from optparse import OptionParser + +__version__ = '2015-07-01' +# See zc.buildout's changelog if this version is up to date. + +tmpeggs = tempfile.mkdtemp(prefix='bootstrap-') + +usage = '''\ +[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options] + +Bootstraps a buildout-based project. + +Simply run this script in a directory containing a buildout.cfg, using the +Python that you want bin/buildout to use. + +Note that by using --find-links to point to local resources, you can keep +this script from going over the network. +''' + +parser = OptionParser(usage=usage) +parser.add_option("--version", + action="store_true", default=False, + help=("Return bootstrap.py version.")) +parser.add_option("-t", "--accept-buildout-test-releases", + dest='accept_buildout_test_releases', + action="store_true", default=False, + help=("Normally, if you do not specify a --buildout-version, " + "the bootstrap script and buildout gets the newest " + "*final* versions of zc.buildout and its recipes and " + "extensions for you. If you use this flag, " + "bootstrap and buildout will get the newest releases " + "even if they are alphas or betas.")) +parser.add_option("-c", "--config-file", + help=("Specify the path to the buildout configuration " + "file to be used.")) +parser.add_option("-f", "--find-links", + help=("Specify a URL to search for buildout releases")) +parser.add_option("--allow-site-packages", + action="store_true", default=False, + help=("Let bootstrap.py use existing site packages")) +parser.add_option("--buildout-version", + help="Use a specific zc.buildout version") +parser.add_option("--setuptools-version", + help="Use a specific setuptools version") +parser.add_option("--setuptools-to-dir", + help=("Allow for re-use of existing directory of " + "setuptools versions")) + +options, args = parser.parse_args() +if options.version: + print("bootstrap.py version %s" % __version__) + sys.exit(0) + + +###################################################################### +# load/install setuptools + +try: + from urllib.request import urlopen +except ImportError: + from urllib2 import urlopen + +ez = {} +if os.path.exists('ez_setup.py'): + exec(open('ez_setup.py').read(), ez) +else: + exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez) + +if not options.allow_site_packages: + # ez_setup imports site, which adds site packages + # this will remove them from the path to ensure that incompatible versions + # of setuptools are not in the path + import site + # inside a virtualenv, there is no 'getsitepackages'. + # We can't remove these reliably + if hasattr(site, 'getsitepackages'): + for sitepackage_path in site.getsitepackages(): + # Strip all site-packages directories from sys.path that + # are not sys.prefix; this is because on Windows + # sys.prefix is a site-package directory. + if sitepackage_path != sys.prefix: + sys.path[:] = [x for x in sys.path + if sitepackage_path not in x] + +setup_args = dict(to_dir=tmpeggs, download_delay=0) + +if options.setuptools_version is not None: + setup_args['version'] = options.setuptools_version +if options.setuptools_to_dir is not None: + setup_args['to_dir'] = options.setuptools_to_dir + +ez['use_setuptools'](**setup_args) +import setuptools +import pkg_resources + +# This does not (always?) update the default working set. We will +# do it. +for path in sys.path: + if path not in pkg_resources.working_set.entries: + pkg_resources.working_set.add_entry(path) + +###################################################################### +# Install buildout + +ws = pkg_resources.working_set + +setuptools_path = ws.find( + pkg_resources.Requirement.parse('setuptools')).location + +# Fix sys.path here as easy_install.pth added before PYTHONPATH +cmd = [sys.executable, '-c', + 'import sys; sys.path[0:0] = [%r]; ' % setuptools_path + + 'from setuptools.command.easy_install import main; main()', + '-mZqNxd', tmpeggs] + +find_links = os.environ.get( + 'bootstrap-testing-find-links', + options.find_links or + ('http://downloads.buildout.org/' + if options.accept_buildout_test_releases else None) + ) +if find_links: + cmd.extend(['-f', find_links]) + +requirement = 'zc.buildout' +version = options.buildout_version +if version is None and not options.accept_buildout_test_releases: + # Figure out the most recent final version of zc.buildout. + import setuptools.package_index + _final_parts = '*final-', '*final' + + def _final_version(parsed_version): + try: + return not parsed_version.is_prerelease + except AttributeError: + # Older setuptools + for part in parsed_version: + if (part[:1] == '*') and (part not in _final_parts): + return False + return True + + index = setuptools.package_index.PackageIndex( + search_path=[setuptools_path]) + if find_links: + index.add_find_links((find_links,)) + req = pkg_resources.Requirement.parse(requirement) + if index.obtain(req) is not None: + best = [] + bestv = None + for dist in index[req.project_name]: + distv = dist.parsed_version + if _final_version(distv): + if bestv is None or distv > bestv: + best = [dist] + bestv = distv + elif distv == bestv: + best.append(dist) + if best: + best.sort() + version = best[-1].version +if version: + requirement = '=='.join((requirement, version)) +cmd.append(requirement) + +import subprocess +if subprocess.call(cmd) != 0: + raise Exception( + "Failed to execute command:\n%s" % repr(cmd)[1:-1]) + +###################################################################### +# Import and run buildout + +ws.add_entry(tmpeggs) +ws.require(requirement) +import zc.buildout.buildout + +if not [a for a in args if '=' not in a]: + args.append('bootstrap') + +# if -c was provided, we push it back into args for buildout' main function +if options.config_file is not None: + args[0:0] = ['-c', options.config_file] + +zc.buildout.buildout.main(args) +shutil.rmtree(tmpeggs) diff -r 000000000000 -r b2be9a32f3fc buildout.cfg --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/buildout.cfg Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,97 @@ +[buildout] +#extensions = buildout.wheel +eggs-directory = /var/local/env/pyams/eggs +extends = http://download.ztfy.org/pyams/pyams-dev.cfg +find-links = http://download.ztfy.org/eggs + +socket-timeout = 3 + +#allow-picked-versions = false +show-picked-versions = true +newest = false + +versions = versions +develop = + . + ../ext/pyramid_es + ../pyams_alchemy + ../pyams_cache + ../pyams_catalog + ../pyams_content + ../pyams_content_es + ../pyams_default_theme + ../pyams_file + ../pyams_form + ../pyams_gis + ../pyams_i18n + ../pyams_ldap + ../pyams_mail + ../pyams_media + ../pyams_notify + ../pyams_notify_ws + ../pyams_pagelet + ../pyams_portal + ../pyams_scheduler + ../pyams_security + ../pyams_sequence + ../pyams_skin + ../pyams_template + ../pyams_thesaurus + ../pyams_utils + ../pyams_viewlet + ../pyams_workflow + ../pyams_zmi + ../pyams_zmq + ../pyams_zodbbrowser + +parts = + package + sphinx + +[package] +recipe = zc.recipe.egg +eggs = + pyams_alchemy + pyams_cache + pyams_catalog + pyams_content + pyams_content_es + pyams_default_theme + pyams_file + pyams_form + pyams_gis + pyams_i18n + pyams_ldap + pyams_mail + pyams_media + pyams_notify + pyams_notify_ws + pyams_pagelet + pyams_portal + pyams_scheduler + pyams_security + pyams_sequence + pyams_skin + pyams_template + pyams_thesaurus + pyams_utils + pyams_viewlet + pyams_workflow + pyams_zmi + pyams_zmq + pyams_zodbbrowser + repoze.lru + zc.lockfile +interpreter = ${buildout:directory}/bin/py + +[sphinx] +recipe = collective.recipe.sphinxbuilder +eggs = + ${package:eggs} + repoze.sphinx.autointerface + sphinx_rtd_theme +source = ${buildout:directory}/src/source +build = ${buildout:directory}/src/build + +[versions] +pyams_user_guide = 0.1.0 diff -r 000000000000 -r b2be9a32f3fc docs/HISTORY.txt diff -r 000000000000 -r b2be9a32f3fc docs/README.txt diff -r 000000000000 -r b2be9a32f3fc requirements.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/requirements.txt Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,47 @@ +--find-links=http://download.ztfy.org/eggs +--trusted-host download.ztfy.org +fanstatic==1.0.0 +hypatia==0.3 +lxml==4.1.1 +Pillow==4.3.0 +pyams-alchemy==0.1.8 +pyams-cache==0.1.3 +pyams-catalog==0.1.8 +pyams-content==0.1.15 +pyams-content-es==0.1.11 +pyams-default-theme==0.1.6 +pyams-file==0.1.16 +pyams-form==0.1.14 +#pyams-gis==0.1.9 +pyams-i18n==0.1.14 +pyams-ldap==0.1.6 +pyams-mail==0.1.1 +pyams-media==0.1.13 +pyams-notify==0.1.7 +pyams-notify-ws==0.1.4 +pyams-pagelet==0.1.2 +pyams-portal==0.1.12 +pyams-scheduler==0.1.11 +pyams-security==0.1.12 +pyams-sequence==0.1.10 +pyams-skin==0.1.17 +pyams-template==0.1.2 +pyams-thesaurus==0.1.10 +pyams-utils==0.1.16 +pyams-viewlet==0.1.4 +pyams-workflow==0.1.13 +pyams-zmi==0.1.9 +pyams-zmq==0.1.3 +pyams-zodbbrowser==0.1.2 +pyramid==1.9.1 +pyramid-es==0.3.2.dev2 +pyramid-fanstatic==0.5 +pyramid-zodbconn==0.7 +pyzmq==16.0.4 +repoze.lru==0.7 +repoze.sphinx.autointerface==0.8 +Sphinx==1.6.7 +sphinx_rtd_theme==0.3.1 +websockets==3.4 +WebOb==1.7.4 +ZODB==5.3.0 diff -r 000000000000 -r b2be9a32f3fc setup.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/setup.py Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,70 @@ +### -*- coding: utf-8 -*- #################################################### +############################################################################## +# +# Copyright (c) 2008-2010 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# +############################################################################## + +""" +This module contains PyAMS ser guide +""" +import os +from setuptools import setup, find_packages + +DOCS = os.path.join(os.path.dirname(__file__), + 'docs') + +README = os.path.join(DOCS, 'README.txt') +HISTORY = os.path.join(DOCS, 'HISTORY.txt') + +version = '0.1.0' +long_description = open(README).read() + '\n\n' + open(HISTORY).read() + +tests_require = [ + 'pyramid_zcml', + 'zc.lockfile' +] + +setup(name='pyams_user_guide', + version=version, + description="PyAMS user guide", + long_description=long_description, + classifiers=[ + "License :: OSI Approved :: Zope Public License", + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Framework :: Zope3", + "Topic :: Software Development :: Libraries :: Python Modules", + ], + keywords='Pyramid PyAMS utilities', + author='Thierry Florac', + author_email='tflorac@ulthar.net', + url='http://www.ztfy.org', + license='ZPL', + packages=find_packages('src'), + package_dir={'': 'src'}, + namespace_packages=[], + include_package_data=True, + package_data={'': ['*.zcml', '*.txt', '*.pt', '*.pot', '*.po', '*.mo', + '*.png', '*.gif', '*.jpeg', '*.jpg', '*.css', '*.js']}, + zip_safe=False, + # uncomment this to be able to run tests with setup.py + test_suite="pyams_utils.tests.test_utilsdocs.test_suite", + tests_require=tests_require, + extras_require=dict(test=tests_require), + install_requires=[ + 'setuptools', + 'repoze.lru', + 'repoze.sphinx.autointerface', + 'sphinx_rtd_theme', + # -*- Extra requirements: -*- + ], + entry_points={}) diff -r 000000000000 -r b2be9a32f3fc src/Makefile --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/Makefile Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = ../bin/sphinx-build +SPHINXPROJ = PyAMSUserGuide +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff -r 000000000000 -r b2be9a32f3fc src/pyams_user_guide.egg-info/PKG-INFO --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_user_guide.egg-info/PKG-INFO Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +Metadata-Version: 1.1 +Name: pyams-user-guide +Version: 0.1.0 +Summary: PyAMS user guide +Home-page: http://www.ztfy.org +Author: Thierry Florac +Author-email: tflorac@ulthar.net +License: ZPL +Description-Content-Type: UNKNOWN +Description: + + +Keywords: Pyramid PyAMS utilities +Platform: UNKNOWN +Classifier: License :: OSI Approved :: Zope Public License +Classifier: Development Status :: 4 - Beta +Classifier: Programming Language :: Python +Classifier: Framework :: Zope3 +Classifier: Topic :: Software Development :: Libraries :: Python Modules diff -r 000000000000 -r b2be9a32f3fc src/pyams_user_guide.egg-info/SOURCES.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_user_guide.egg-info/SOURCES.txt Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,8 @@ +setup.py +src/pyams_user_guide.egg-info/PKG-INFO +src/pyams_user_guide.egg-info/SOURCES.txt +src/pyams_user_guide.egg-info/dependency_links.txt +src/pyams_user_guide.egg-info/namespace_packages.txt +src/pyams_user_guide.egg-info/not-zip-safe +src/pyams_user_guide.egg-info/requires.txt +src/pyams_user_guide.egg-info/top_level.txt \ No newline at end of file diff -r 000000000000 -r b2be9a32f3fc src/pyams_user_guide.egg-info/dependency_links.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_user_guide.egg-info/dependency_links.txt Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r b2be9a32f3fc src/pyams_user_guide.egg-info/namespace_packages.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_user_guide.egg-info/namespace_packages.txt Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r b2be9a32f3fc src/pyams_user_guide.egg-info/not-zip-safe --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_user_guide.egg-info/not-zip-safe Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r b2be9a32f3fc src/pyams_user_guide.egg-info/requires.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_user_guide.egg-info/requires.txt Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,8 @@ +setuptools +repoze.lru +repoze.sphinx.autointerface +sphinx_rtd_theme + +[test] +pyramid_zcml +zc.lockfile diff -r 000000000000 -r b2be9a32f3fc src/pyams_user_guide.egg-info/top_level.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_user_guide.egg-info/top_level.txt Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r b2be9a32f3fc src/source/_static/add_newtopic.png Binary file src/source/_static/add_newtopic.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/annotations-1.png Binary file src/source/_static/annotations-1.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/annotations-2.png Binary file src/source/_static/annotations-2.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/architecture_dev.png Binary file src/source/_static/architecture_dev.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/architecture_prod.png Binary file src/source/_static/architecture_prod.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/architecture_quickstart.png Binary file src/source/_static/architecture_quickstart.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/associations_form.png Binary file src/source/_static/associations_form.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/content_actions_toolbar.png Binary file src/source/_static/content_actions_toolbar.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/content_other_actions.png Binary file src/source/_static/content_other_actions.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/content_paragraph.png Binary file src/source/_static/content_paragraph.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/content_properties.png Binary file src/source/_static/content_properties.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/content_publication_form.png Binary file src/source/_static/content_publication_form.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/content_publish_toolbar.png Binary file src/source/_static/content_publish_toolbar.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/content_validation.png Binary file src/source/_static/content_validation.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/css/custom.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/_static/css/custom.css Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,7 @@ +.wy-menu .caption-text{ + color: #2D87C2; +} + +.headerlink::before{ + color: #2D87C2; +} diff -r 000000000000 -r b2be9a32f3fc src/source/_static/css/custom.min.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/_static/css/custom.min.css Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,1 @@ +.wy-menu .caption-text{color:#2d87c2}.headerlink::before{color:#2d87c2} diff -r 000000000000 -r b2be9a32f3fc src/source/_static/nav_site_management.png Binary file src/source/_static/nav_site_management.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/pyams-control-panel.png Binary file src/source/_static/pyams-control-panel.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/pyams-dashboard.png Binary file src/source/_static/pyams-dashboard.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/pyams-login.png Binary file src/source/_static/pyams-login.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/pyams-paragraphs.png Binary file src/source/_static/pyams-paragraphs.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/pyams-properties.png Binary file src/source/_static/pyams-properties.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/select_add_links.png Binary file src/source/_static/select_add_links.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/select_links_n_attachment.png Binary file src/source/_static/select_links_n_attachment.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/select_portlet.png Binary file src/source/_static/select_portlet.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/select_sitetree.png Binary file src/source/_static/select_sitetree.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/select_skin.png Binary file src/source/_static/select_skin.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/select_website_content.png Binary file src/source/_static/select_website_content.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/shared_content_settings.png Binary file src/source/_static/shared_content_settings.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/site_add_content.png Binary file src/source/_static/site_add_content.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/site_link_content.png Binary file src/source/_static/site_link_content.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/site_linked_content.png Binary file src/source/_static/site_linked_content.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/template_edit_config.png Binary file src/source/_static/template_edit_config.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/user_create_template.png Binary file src/source/_static/user_create_template.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/zeo-add-form.png Binary file src/source/_static/zeo-add-form.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/_static/zeo-add-menu.png Binary file src/source/_static/zeo-add-menu.png has changed diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/README.txt Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,2 @@ +Don't edit these files manually +Theses RST files are generated automatically using the source code and python docstring of packages. diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/howto-i18n.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/howto-i18n.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _howto-i18n: + + +pot-create -o ref.pot scr/ +msgmerge -U def.po ref.pot +msgfmt def.po + +#bin/pot-create -o src/onf_website/locales/onf_website.pot src/ +#msgmerge -U --previous --sort-by-file src/onf_website/locales/fr/LC_MESSAGES/onf_website.po src/onf_website/locales/onf_website.pot +#msgfmt src/onf_website/locales/fr/LC_MESSAGES/onf_website.po -o src/onf_website/locales/fr/LC_MESSAGES/onf_website.mo diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_alchemy/pyams_alchemy.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_alchemy/pyams_alchemy.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_alchemy.interfaces: + +\ :mod:`pyams_alchemy.interfaces` package +========================================= + +.. automodule:: pyams_alchemy.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_alchemy/pyams_alchemy.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_alchemy/pyams_alchemy.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,60 @@ +.. _pyams_alchemy: + +\ :mod:`pyams_alchemy` package +============================== + +.. automodule:: pyams_alchemy + :members: + :undoc-members: + :show-inheritance: + +pyams_alchemy.\ ``engine`` +-------------------------- + +.. automodule:: pyams_alchemy.engine + :members: + :undoc-members: + :show-inheritance: + +pyams_alchemy.\ ``loader`` +-------------------------- + +.. automodule:: pyams_alchemy.loader + :members: + :undoc-members: + :show-inheritance: + +pyams_alchemy.\ ``metaconfigure`` +--------------------------------- + +.. automodule:: pyams_alchemy.metaconfigure + :members: + :undoc-members: + :show-inheritance: + +pyams_alchemy.\ ``metadirectives`` +---------------------------------- + +.. automodule:: pyams_alchemy.metadirectives + :members: + :undoc-members: + :show-inheritance: + +pyams_alchemy.\ ``mixin`` +------------------------- + +.. automodule:: pyams_alchemy.mixin + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_alchemy.interfaces + pyams_alchemy.tests + pyams_alchemy.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_alchemy/pyams_alchemy.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_alchemy/pyams_alchemy.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_alchemy.tests: + +\ :mod:`pyams_alchemy.tests` package +==================================== + +.. automodule:: pyams_alchemy.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_alchemy.tests.\ ``test_utilsdocs`` +---------------------------------------- + +.. automodule:: pyams_alchemy.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_alchemy.tests.\ ``test_utilsdocstrings`` +---------------------------------------------- + +.. automodule:: pyams_alchemy.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_alchemy/pyams_alchemy.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_alchemy/pyams_alchemy.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_alchemy.zmi: + +\ :mod:`pyams_alchemy.zmi` package +================================== + +.. automodule:: pyams_alchemy.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_alchemy.zmi.\ ``engine`` +------------------------------ + +.. automodule:: pyams_alchemy.zmi.engine + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_cache/pyams_cache.handler.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_cache/pyams_cache.handler.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_cache.handler: + +\ :mod:`pyams_cache.handler` package +==================================== + +.. automodule:: pyams_cache.handler + :members: + :undoc-members: + :show-inheritance: + +pyams_cache.handler.\ ``memcached`` +----------------------------------- + +.. automodule:: pyams_cache.handler.memcached + :members: + :undoc-members: + :show-inheritance: + +pyams_cache.handler.\ ``redis`` +------------------------------- + +.. automodule:: pyams_cache.handler.redis + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_cache/pyams_cache.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_cache/pyams_cache.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_cache.interfaces: + +\ :mod:`pyams_cache.interfaces` package +======================================= + +.. automodule:: pyams_cache.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_cache/pyams_cache.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_cache/pyams_cache.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,44 @@ +.. _pyams_cache: + +\ :mod:`pyams_cache` package +============================ + +.. automodule:: pyams_cache + :members: + :undoc-members: + :show-inheritance: + +pyams_cache.\ ``beaker`` +------------------------ + +.. automodule:: pyams_cache.beaker + :members: + :undoc-members: + :show-inheritance: + +pyams_cache.\ ``cache`` +----------------------- + +.. automodule:: pyams_cache.cache + :members: + :undoc-members: + :show-inheritance: + +pyams_cache.\ ``include`` +------------------------- + +.. automodule:: pyams_cache.include + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_cache.handler + pyams_cache.interfaces + pyams_cache.tests + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_cache/pyams_cache.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_cache/pyams_cache.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_cache.tests: + +\ :mod:`pyams_cache.tests` package +================================== + +.. automodule:: pyams_cache.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_cache.tests.\ ``test_utilsdocs`` +-------------------------------------- + +.. automodule:: pyams_cache.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_cache.tests.\ ``test_utilsdocstrings`` +-------------------------------------------- + +.. automodule:: pyams_cache.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_catalog/pyams_catalog.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_catalog/pyams_catalog.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_catalog.interfaces: + +\ :mod:`pyams_catalog.interfaces` package +========================================= + +.. automodule:: pyams_catalog.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_catalog/pyams_catalog.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_catalog/pyams_catalog.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,68 @@ +.. _pyams_catalog: + +\ :mod:`pyams_catalog` package +============================== + +.. automodule:: pyams_catalog + :members: + :undoc-members: + :show-inheritance: + +pyams_catalog.\ ``include`` +--------------------------- + +.. automodule:: pyams_catalog.include + :members: + :undoc-members: + :show-inheritance: + +pyams_catalog.\ ``index`` +------------------------- + +.. automodule:: pyams_catalog.index + :members: + :undoc-members: + :show-inheritance: + +pyams_catalog.\ ``nltk`` +------------------------ + +.. automodule:: pyams_catalog.nltk + :members: + :undoc-members: + :show-inheritance: + +pyams_catalog.\ ``query`` +------------------------- + +.. automodule:: pyams_catalog.query + :members: + :undoc-members: + :show-inheritance: + +pyams_catalog.\ ``site`` +------------------------ + +.. automodule:: pyams_catalog.site + :members: + :undoc-members: + :show-inheritance: + +pyams_catalog.\ ``utils`` +------------------------- + +.. automodule:: pyams_catalog.utils + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_catalog.interfaces + pyams_catalog.tests + pyams_catalog.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_catalog/pyams_catalog.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_catalog/pyams_catalog.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_catalog.tests: + +\ :mod:`pyams_catalog.tests` package +==================================== + +.. automodule:: pyams_catalog.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_catalog.tests.\ ``test_utilsdocs`` +---------------------------------------- + +.. automodule:: pyams_catalog.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_catalog.tests.\ ``test_utilsdocstrings`` +---------------------------------------------- + +.. automodule:: pyams_catalog.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_catalog/pyams_catalog.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_catalog/pyams_catalog.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_catalog.zmi: + +\ :mod:`pyams_catalog.zmi` package +================================== + +.. automodule:: pyams_catalog.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_catalog.zmi.\ ``catalog`` +------------------------------- + +.. automodule:: pyams_catalog.zmi.catalog + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.association.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.association.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.component.association.interfaces: + +\ :mod:`pyams_content.component.association.interfaces` package +=============================================================== + +.. automodule:: pyams_content.component.association.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.association.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.association.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_content.component.association: + +\ :mod:`pyams_content.component.association` package +==================================================== + +.. automodule:: pyams_content.component.association + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.association.\ ``container`` +--------------------------------------------------- + +.. automodule:: pyams_content.component.association.container + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.association.\ ``paragraph`` +--------------------------------------------------- + +.. automodule:: pyams_content.component.association.paragraph + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.association.interfaces + pyams_content.component.association.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.association.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.association.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.component.association.zmi: + +\ :mod:`pyams_content.component.association.zmi` package +======================================================== + +.. automodule:: pyams_content.component.association.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.association.zmi.\ ``interfaces`` +-------------------------------------------------------- + +.. automodule:: pyams_content.component.association.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.association.zmi.\ ``paragraph`` +------------------------------------------------------- + +.. automodule:: pyams_content.component.association.zmi.paragraph + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.extfile.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.extfile.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.component.extfile.interfaces: + +\ :mod:`pyams_content.component.extfile.interfaces` package +=========================================================== + +.. automodule:: pyams_content.component.extfile.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.extfile.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.extfile.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,18 @@ +.. _pyams_content.component.extfile: + +\ :mod:`pyams_content.component.extfile` package +================================================ + +.. automodule:: pyams_content.component.extfile + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.extfile.interfaces + pyams_content.component.extfile.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.extfile.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.extfile.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.component.extfile.zmi: + +\ :mod:`pyams_content.component.extfile.zmi` package +==================================================== + +.. automodule:: pyams_content.component.extfile.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.extfile.zmi.\ ``container`` +--------------------------------------------------- + +.. automodule:: pyams_content.component.extfile.zmi.container + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.gallery.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.gallery.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.component.gallery.interfaces: + +\ :mod:`pyams_content.component.gallery.interfaces` package +=========================================================== + +.. automodule:: pyams_content.component.gallery.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.gallery.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.gallery.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_content.component.gallery: + +\ :mod:`pyams_content.component.gallery` package +================================================ + +.. automodule:: pyams_content.component.gallery + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.gallery.\ ``file`` +------------------------------------------ + +.. automodule:: pyams_content.component.gallery.file + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.gallery.\ ``paragraph`` +----------------------------------------------- + +.. automodule:: pyams_content.component.gallery.paragraph + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.gallery.interfaces + pyams_content.component.gallery.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.gallery.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.gallery.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_content.component.gallery.zmi: + +\ :mod:`pyams_content.component.gallery.zmi` package +==================================================== + +.. automodule:: pyams_content.component.gallery.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.gallery.zmi.\ ``file`` +---------------------------------------------- + +.. automodule:: pyams_content.component.gallery.zmi.file + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.gallery.zmi.\ ``interfaces`` +---------------------------------------------------- + +.. automodule:: pyams_content.component.gallery.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.gallery.zmi.\ ``paragraph`` +--------------------------------------------------- + +.. automodule:: pyams_content.component.gallery.zmi.paragraph + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.illustration.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.illustration.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.component.illustration.interfaces: + +\ :mod:`pyams_content.component.illustration.interfaces` package +================================================================ + +.. automodule:: pyams_content.component.illustration.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.illustration.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.illustration.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.component.illustration: + +\ :mod:`pyams_content.component.illustration` package +===================================================== + +.. automodule:: pyams_content.component.illustration + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.illustration.\ ``paragraph`` +---------------------------------------------------- + +.. automodule:: pyams_content.component.illustration.paragraph + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.illustration.interfaces + pyams_content.component.illustration.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.illustration.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.illustration.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.component.illustration.zmi: + +\ :mod:`pyams_content.component.illustration.zmi` package +========================================================= + +.. automodule:: pyams_content.component.illustration.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.illustration.zmi.\ ``paragraph`` +-------------------------------------------------------- + +.. automodule:: pyams_content.component.illustration.zmi.paragraph + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.links.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.links.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.component.links.interfaces: + +\ :mod:`pyams_content.component.links.interfaces` package +========================================================= + +.. automodule:: pyams_content.component.links.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.links.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.links.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,18 @@ +.. _pyams_content.component.links: + +\ :mod:`pyams_content.component.links` package +============================================== + +.. automodule:: pyams_content.component.links + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.links.interfaces + pyams_content.component.links.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.links.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.links.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.component.links.zmi: + +\ :mod:`pyams_content.component.links.zmi` package +================================================== + +.. automodule:: pyams_content.component.links.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.links.zmi.\ ``container`` +------------------------------------------------- + +.. automodule:: pyams_content.component.links.zmi.container + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.links.zmi.\ ``reverse`` +----------------------------------------------- + +.. automodule:: pyams_content.component.links.zmi.reverse + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.media.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.media.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.component.media: + +\ :mod:`pyams_content.component.media` package +============================================== + +.. automodule:: pyams_content.component.media + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.paragraph.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.paragraph.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,99 @@ +.. _pyams_content.component.paragraph.interfaces: + +\ :mod:`pyams_content.component.paragraph.interfaces` package +============================================================= + +.. automodule:: pyams_content.component.paragraph.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``audio`` +-------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.audio + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``contact`` +---------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.contact + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``frame`` +-------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.frame + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``header`` +--------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.header + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``html`` +------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.html + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``keynumber`` +------------------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.interfaces.keynumber + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``keypoint`` +----------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.keypoint + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``milestone`` +------------------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.interfaces.milestone + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``pictogram`` +------------------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.interfaces.pictogram + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``verbatim`` +----------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.verbatim + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.interfaces.\ ``video`` +-------------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.interfaces.video + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.paragraph.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.paragraph.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,115 @@ +.. _pyams_content.component.paragraph: + +\ :mod:`pyams_content.component.paragraph` package +================================================== + +.. automodule:: pyams_content.component.paragraph + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``audio`` +--------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.audio + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``contact`` +----------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.contact + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``container`` +------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.container + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``frame`` +--------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.frame + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``header`` +---------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.header + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``html`` +-------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.html + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``keynumber`` +------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.keynumber + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``keypoint`` +------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.keypoint + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``milestone`` +------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.milestone + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``pictogram`` +------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.pictogram + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``verbatim`` +------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.verbatim + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.\ ``video`` +--------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.video + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.paragraph.interfaces + pyams_content.component.paragraph.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.paragraph.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.paragraph.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,123 @@ +.. _pyams_content.component.paragraph.zmi: + +\ :mod:`pyams_content.component.paragraph.zmi` package +====================================================== + +.. automodule:: pyams_content.component.paragraph.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``audio`` +------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.audio + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``contact`` +--------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.contact + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``container`` +----------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.container + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``frame`` +------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.frame + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``header`` +-------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.header + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``html`` +------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.zmi.html + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``interfaces`` +------------------------------------------------------ + +.. automodule:: pyams_content.component.paragraph.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``keynumber`` +----------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.keynumber + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``keypoint`` +---------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.keypoint + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``milestone`` +----------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.milestone + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``pictogram`` +----------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.pictogram + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``preview`` +--------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.preview + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``verbatim`` +---------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.verbatim + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.paragraph.zmi.\ ``video`` +------------------------------------------------- + +.. automodule:: pyams_content.component.paragraph.zmi.video + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,25 @@ +.. _pyams_content.component: + +\ :mod:`pyams_content.component` package +======================================== + +.. automodule:: pyams_content.component + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.association + pyams_content.component.extfile + pyams_content.component.gallery + pyams_content.component.illustration + pyams_content.component.links + pyams_content.component.media + pyams_content.component.paragraph + pyams_content.component.theme + pyams_content.component.video + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.theme.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.theme.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.component.theme.interfaces: + +\ :mod:`pyams_content.component.theme.interfaces` package +========================================================= + +.. automodule:: pyams_content.component.theme.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.theme.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.theme.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.component.theme: + +\ :mod:`pyams_content.component.theme` package +============================================== + +.. automodule:: pyams_content.component.theme + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.theme.\ ``portlet`` +------------------------------------------- + +.. automodule:: pyams_content.component.theme.portlet + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.theme.interfaces + pyams_content.component.theme.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.theme.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.theme.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.component.theme.zmi: + +\ :mod:`pyams_content.component.theme.zmi` package +================================================== + +.. automodule:: pyams_content.component.theme.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.theme.zmi.\ ``manager`` +----------------------------------------------- + +.. automodule:: pyams_content.component.theme.zmi.manager + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.theme.zmi.\ ``portlet`` +----------------------------------------------- + +.. automodule:: pyams_content.component.theme.zmi.portlet + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.video.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.video.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.component.video.interfaces: + +\ :mod:`pyams_content.component.video.interfaces` package +========================================================= + +.. automodule:: pyams_content.component.video.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.video.provider.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.video.provider.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,50 @@ +.. _pyams_content.component.video.provider: + +\ :mod:`pyams_content.component.video.provider` package +======================================================= + +.. automodule:: pyams_content.component.video.provider + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.video.provider.\ ``dailymotion`` +-------------------------------------------------------- + +.. automodule:: pyams_content.component.video.provider.dailymotion + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.video.provider.\ ``interfaces`` +------------------------------------------------------- + +.. automodule:: pyams_content.component.video.provider.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.video.provider.\ ``vimeo`` +-------------------------------------------------- + +.. automodule:: pyams_content.component.video.provider.vimeo + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.video.provider.\ ``youtube`` +---------------------------------------------------- + +.. automodule:: pyams_content.component.video.provider.youtube + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.video.provider.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.video.provider.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.video.provider.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.component.video.provider.zmi: + +\ :mod:`pyams_content.component.video.provider.zmi` package +=========================================================== + +.. automodule:: pyams_content.component.video.provider.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.video.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.video.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,28 @@ +.. _pyams_content.component.video: + +\ :mod:`pyams_content.component.video` package +============================================== + +.. automodule:: pyams_content.component.video + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.video.\ ``paragraph`` +--------------------------------------------- + +.. automodule:: pyams_content.component.video.paragraph + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.component.video.interfaces + pyams_content.component.video.provider + pyams_content.component.video.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.component.video.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.component.video.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.component.video.zmi: + +\ :mod:`pyams_content.component.video.zmi` package +================================================== + +.. automodule:: pyams_content.component.video.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.component.video.zmi.\ ``paragraph`` +------------------------------------------------- + +.. automodule:: pyams_content.component.video.zmi.paragraph + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.alert.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.alert.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,34 @@ +.. _pyams_content.features.alert: + +\ :mod:`pyams_content.features.alert` package +============================================= + +.. automodule:: pyams_content.features.alert + :members: + :undoc-members: + :show-inheritance: + +pyams_content.features.alert.\ ``container`` +-------------------------------------------- + +.. automodule:: pyams_content.features.alert.container + :members: + :undoc-members: + :show-inheritance: + +pyams_content.features.alert.\ ``interfaces`` +--------------------------------------------- + +.. automodule:: pyams_content.features.alert.interfaces + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.features.alert.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.alert.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.alert.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.features.alert.zmi: + +\ :mod:`pyams_content.features.alert.zmi` package +================================================= + +.. automodule:: pyams_content.features.alert.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.features.alert.zmi.\ ``container`` +------------------------------------------------ + +.. automodule:: pyams_content.features.alert.zmi.container + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.checker.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.checker.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,26 @@ +.. _pyams_content.features.checker: + +\ :mod:`pyams_content.features.checker` package +=============================================== + +.. automodule:: pyams_content.features.checker + :members: + :undoc-members: + :show-inheritance: + +pyams_content.features.checker.\ ``interfaces`` +----------------------------------------------- + +.. automodule:: pyams_content.features.checker.interfaces + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.features.checker.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.checker.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.checker.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.checker.zmi: + +\ :mod:`pyams_content.features.checker.zmi` package +=================================================== + +.. automodule:: pyams_content.features.checker.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.footer.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.footer.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.footer.interfaces: + +\ :mod:`pyams_content.features.footer.interfaces` package +========================================================= + +.. automodule:: pyams_content.features.footer.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.footer.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.footer.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.features.footer: + +\ :mod:`pyams_content.features.footer` package +============================================== + +.. automodule:: pyams_content.features.footer + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.features.footer.interfaces + pyams_content.features.footer.skin + pyams_content.features.footer.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.footer.skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.footer.skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.footer.skin: + +\ :mod:`pyams_content.features.footer.skin` package +=================================================== + +.. automodule:: pyams_content.features.footer.skin + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.footer.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.footer.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.footer.zmi: + +\ :mod:`pyams_content.features.footer.zmi` package +================================================== + +.. automodule:: pyams_content.features.footer.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.header.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.header.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.header.interfaces: + +\ :mod:`pyams_content.features.header.interfaces` package +========================================================= + +.. automodule:: pyams_content.features.header.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.header.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.header.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.features.header: + +\ :mod:`pyams_content.features.header` package +============================================== + +.. automodule:: pyams_content.features.header + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.features.header.interfaces + pyams_content.features.header.skin + pyams_content.features.header.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.header.skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.header.skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.header.skin: + +\ :mod:`pyams_content.features.header.skin` package +=================================================== + +.. automodule:: pyams_content.features.header.skin + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.header.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.header.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.header.zmi: + +\ :mod:`pyams_content.features.header.zmi` package +================================================== + +.. automodule:: pyams_content.features.header.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.preview.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.preview.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,26 @@ +.. _pyams_content.features.preview: + +\ :mod:`pyams_content.features.preview` package +=============================================== + +.. automodule:: pyams_content.features.preview + :members: + :undoc-members: + :show-inheritance: + +pyams_content.features.preview.\ ``interfaces`` +----------------------------------------------- + +.. automodule:: pyams_content.features.preview.interfaces + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.features.preview.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.preview.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.preview.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.features.preview.zmi: + +\ :mod:`pyams_content.features.preview.zmi` package +=================================================== + +.. automodule:: pyams_content.features.preview.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.features.preview.zmi.\ ``interfaces`` +--------------------------------------------------- + +.. automodule:: pyams_content.features.preview.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.renderer.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.renderer.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.renderer.interfaces: + +\ :mod:`pyams_content.features.renderer.interfaces` package +=========================================================== + +.. automodule:: pyams_content.features.renderer.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.renderer.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.renderer.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.features.renderer: + +\ :mod:`pyams_content.features.renderer` package +================================================ + +.. automodule:: pyams_content.features.renderer + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.features.renderer.interfaces + pyams_content.features.renderer.skin + pyams_content.features.renderer.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.renderer.skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.renderer.skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.renderer.skin: + +\ :mod:`pyams_content.features.renderer.skin` package +===================================================== + +.. automodule:: pyams_content.features.renderer.skin + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.renderer.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.renderer.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.features.renderer.zmi: + +\ :mod:`pyams_content.features.renderer.zmi` package +==================================================== + +.. automodule:: pyams_content.features.renderer.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.features.renderer.zmi.\ ``widget`` +------------------------------------------------ + +.. automodule:: pyams_content.features.renderer.zmi.widget + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.review.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.review.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,26 @@ +.. _pyams_content.features.review: + +\ :mod:`pyams_content.features.review` package +============================================== + +.. automodule:: pyams_content.features.review + :members: + :undoc-members: + :show-inheritance: + +pyams_content.features.review.\ ``interfaces`` +---------------------------------------------- + +.. automodule:: pyams_content.features.review.interfaces + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.features.review.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.review.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.review.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.features.review.zmi: + +\ :mod:`pyams_content.features.review.zmi` package +================================================== + +.. automodule:: pyams_content.features.review.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.features.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.features.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,23 @@ +.. _pyams_content.features: + +\ :mod:`pyams_content.features` package +======================================= + +.. automodule:: pyams_content.features + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.features.alert + pyams_content.features.checker + pyams_content.features.footer + pyams_content.features.header + pyams_content.features.preview + pyams_content.features.renderer + pyams_content.features.review + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.generations.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.generations.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.generations: + +\ :mod:`pyams_content.generations` package +========================================== + +.. automodule:: pyams_content.generations + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.interfaces: + +\ :mod:`pyams_content.interfaces` package +========================================= + +.. automodule:: pyams_content.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_content.interfaces.\ ``container`` +---------------------------------------- + +.. automodule:: pyams_content.interfaces.container + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.profile.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.profile.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.profile.interfaces: + +\ :mod:`pyams_content.profile.interfaces` package +================================================= + +.. automodule:: pyams_content.profile.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.profile.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.profile.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.profile: + +\ :mod:`pyams_content.profile` package +====================================== + +.. automodule:: pyams_content.profile + :members: + :undoc-members: + :show-inheritance: + +pyams_content.profile.\ ``admin`` +--------------------------------- + +.. automodule:: pyams_content.profile.admin + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.profile.interfaces + pyams_content.profile.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.profile.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.profile.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.profile.zmi: + +\ :mod:`pyams_content.profile.zmi` package +========================================== + +.. automodule:: pyams_content.profile.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.reference.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.reference.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.reference.interfaces: + +\ :mod:`pyams_content.reference.interfaces` package +=================================================== + +.. automodule:: pyams_content.reference.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.reference.pictograms.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.reference.pictograms.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.reference.pictograms.interfaces: + +\ :mod:`pyams_content.reference.pictograms.interfaces` package +============================================================== + +.. automodule:: pyams_content.reference.pictograms.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.reference.pictograms.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.reference.pictograms.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.reference.pictograms: + +\ :mod:`pyams_content.reference.pictograms` package +=================================================== + +.. automodule:: pyams_content.reference.pictograms + :members: + :undoc-members: + :show-inheritance: + +pyams_content.reference.pictograms.\ ``manager`` +------------------------------------------------ + +.. automodule:: pyams_content.reference.pictograms.manager + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.reference.pictograms.interfaces + pyams_content.reference.pictograms.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.reference.pictograms.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.reference.pictograms.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.reference.pictograms.zmi: + +\ :mod:`pyams_content.reference.pictograms.zmi` package +======================================================= + +.. automodule:: pyams_content.reference.pictograms.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.reference.pictograms.zmi.\ ``manager`` +---------------------------------------------------- + +.. automodule:: pyams_content.reference.pictograms.zmi.manager + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.reference.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.reference.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.reference: + +\ :mod:`pyams_content.reference` package +======================================== + +.. automodule:: pyams_content.reference + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.reference.interfaces + pyams_content.reference.pictograms + pyams_content.reference.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.reference.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.reference.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.reference.zmi: + +\ :mod:`pyams_content.reference.zmi` package +============================================ + +.. automodule:: pyams_content.reference.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.reference.zmi.\ ``table`` +--------------------------------------- + +.. automodule:: pyams_content.reference.zmi.table + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.root.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.root.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.root.interfaces: + +\ :mod:`pyams_content.root.interfaces` package +============================================== + +.. automodule:: pyams_content.root.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.root.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.root.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,18 @@ +.. _pyams_content.root: + +\ :mod:`pyams_content.root` package +=================================== + +.. automodule:: pyams_content.root + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.root.interfaces + pyams_content.root.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.root.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.root.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.root.zmi: + +\ :mod:`pyams_content.root.zmi` package +======================================= + +.. automodule:: pyams_content.root.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.root.zmi.\ ``search`` +----------------------------------- + +.. automodule:: pyams_content.root.zmi.search + :members: + :undoc-members: + :show-inheritance: + +pyams_content.root.zmi.\ ``sites`` +---------------------------------- + +.. automodule:: pyams_content.root.zmi.sites + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,45 @@ +.. _pyams_content: + +\ :mod:`pyams_content` package +============================== + +.. automodule:: pyams_content + :members: + :undoc-members: + :show-inheritance: + +pyams_content.\ ``include`` +--------------------------- + +.. automodule:: pyams_content.include + :members: + :undoc-members: + :show-inheritance: + +pyams_content.\ ``site`` +------------------------ + +.. automodule:: pyams_content.site + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.component + pyams_content.generations + pyams_content.features + 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 + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.scripts.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.scripts.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.scripts: + +\ :mod:`pyams_content.scripts` package +====================================== + +.. automodule:: pyams_content.scripts + :members: + :undoc-members: + :show-inheritance: + +pyams_content.scripts.\ ``index`` +--------------------------------- + +.. automodule:: pyams_content.scripts.index + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.blog.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.blog.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.shared.blog.interfaces: + +\ :mod:`pyams_content.shared.blog.interfaces` package +===================================================== + +.. automodule:: pyams_content.shared.blog.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.blog.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.blog.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.shared.blog: + +\ :mod:`pyams_content.shared.blog` package +========================================== + +.. automodule:: pyams_content.shared.blog + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.blog.\ ``manager`` +--------------------------------------- + +.. automodule:: pyams_content.shared.blog.manager + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.blog.interfaces + pyams_content.shared.blog.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.blog.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.blog.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.shared.blog.zmi: + +\ :mod:`pyams_content.shared.blog.zmi` package +============================================== + +.. automodule:: pyams_content.shared.blog.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.blog.zmi.\ ``manager`` +------------------------------------------- + +.. automodule:: pyams_content.shared.blog.zmi.manager + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.common.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.common.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.shared.common.interfaces: + +\ :mod:`pyams_content.shared.common.interfaces` package +======================================================= + +.. automodule:: pyams_content.shared.common.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.interfaces.\ ``types`` +-------------------------------------------------- + +.. automodule:: pyams_content.shared.common.interfaces.types + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.interfaces.\ ``zmi`` +------------------------------------------------ + +.. automodule:: pyams_content.shared.common.interfaces.zmi + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.common.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.common.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_content.shared.common: + +\ :mod:`pyams_content.shared.common` package +============================================ + +.. automodule:: pyams_content.shared.common + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.\ ``manager`` +----------------------------------------- + +.. automodule:: pyams_content.shared.common.manager + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.\ ``security`` +------------------------------------------ + +.. automodule:: pyams_content.shared.common.security + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.\ ``types`` +--------------------------------------- + +.. automodule:: pyams_content.shared.common.types + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.common.interfaces + pyams_content.shared.common.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.common.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.common.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,107 @@ +.. _pyams_content.shared.common.zmi: + +\ :mod:`pyams_content.shared.common.zmi` package +================================================ + +.. automodule:: pyams_content.shared.common.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``dashboard`` +----------------------------------------------- + +.. automodule:: pyams_content.shared.common.zmi.dashboard + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``header`` +-------------------------------------------- + +.. automodule:: pyams_content.shared.common.zmi.header + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``i18n`` +------------------------------------------ + +.. automodule:: pyams_content.shared.common.zmi.i18n + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``manager`` +--------------------------------------------- + +.. automodule:: pyams_content.shared.common.zmi.manager + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``owner`` +------------------------------------------- + +.. automodule:: pyams_content.shared.common.zmi.owner + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``properties`` +------------------------------------------------ + +.. automodule:: pyams_content.shared.common.zmi.properties + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``search`` +-------------------------------------------- + +.. automodule:: pyams_content.shared.common.zmi.search + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``security`` +---------------------------------------------- + +.. automodule:: pyams_content.shared.common.zmi.security + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``site`` +------------------------------------------ + +.. automodule:: pyams_content.shared.common.zmi.site + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``summary`` +--------------------------------------------- + +.. automodule:: pyams_content.shared.common.zmi.summary + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``types`` +------------------------------------------- + +.. automodule:: pyams_content.shared.common.zmi.types + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.common.zmi.\ ``workflow`` +---------------------------------------------- + +.. automodule:: pyams_content.shared.common.zmi.workflow + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.form.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.form.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.shared.form.interfaces: + +\ :mod:`pyams_content.shared.form.interfaces` package +===================================================== + +.. automodule:: pyams_content.shared.form.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.form.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.form.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_content.shared.form: + +\ :mod:`pyams_content.shared.form` package +========================================== + +.. automodule:: pyams_content.shared.form + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.form.\ ``field`` +------------------------------------- + +.. automodule:: pyams_content.shared.form.field + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.form.\ ``handler`` +--------------------------------------- + +.. automodule:: pyams_content.shared.form.handler + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.form.\ ``manager`` +--------------------------------------- + +.. automodule:: pyams_content.shared.form.manager + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.form.interfaces + pyams_content.shared.form.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.form.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.form.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_content.shared.form.zmi: + +\ :mod:`pyams_content.shared.form.zmi` package +============================================== + +.. automodule:: pyams_content.shared.form.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.form.zmi.\ ``field`` +----------------------------------------- + +.. automodule:: pyams_content.shared.form.zmi.field + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.form.zmi.\ ``properties`` +---------------------------------------------- + +.. automodule:: pyams_content.shared.form.zmi.properties + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.form.zmi.\ ``render`` +------------------------------------------ + +.. automodule:: pyams_content.shared.form.zmi.render + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.imagemap.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.imagemap.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.shared.imagemap.interfaces: + +\ :mod:`pyams_content.shared.imagemap.interfaces` package +========================================================= + +.. automodule:: pyams_content.shared.imagemap.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.imagemap.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.imagemap.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_content.shared.imagemap: + +\ :mod:`pyams_content.shared.imagemap` package +============================================== + +.. automodule:: pyams_content.shared.imagemap + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.imagemap.\ ``manager`` +------------------------------------------- + +.. automodule:: pyams_content.shared.imagemap.manager + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.imagemap.\ ``paragraph`` +--------------------------------------------- + +.. automodule:: pyams_content.shared.imagemap.paragraph + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.imagemap.\ ``schema`` +------------------------------------------ + +.. automodule:: pyams_content.shared.imagemap.schema + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.imagemap.interfaces + pyams_content.shared.imagemap.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.imagemap.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.imagemap.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,51 @@ +.. _pyams_content.shared.imagemap.zmi: + +\ :mod:`pyams_content.shared.imagemap.zmi` package +================================================== + +.. automodule:: pyams_content.shared.imagemap.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.imagemap.zmi.\ ``area`` +-------------------------------------------- + +.. automodule:: pyams_content.shared.imagemap.zmi.area + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.imagemap.zmi.\ ``container`` +------------------------------------------------- + +.. automodule:: pyams_content.shared.imagemap.zmi.container + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.imagemap.zmi.\ ``paragraph`` +------------------------------------------------- + +.. automodule:: pyams_content.shared.imagemap.zmi.paragraph + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.imagemap.zmi.\ ``properties`` +-------------------------------------------------- + +.. automodule:: pyams_content.shared.imagemap.zmi.properties + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.imagemap.zmi.\ ``widget`` +---------------------------------------------- + +.. automodule:: pyams_content.shared.imagemap.zmi.widget + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.logo.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.logo.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.shared.logo.interfaces: + +\ :mod:`pyams_content.shared.logo.interfaces` package +===================================================== + +.. automodule:: pyams_content.shared.logo.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.logo.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.logo.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_content.shared.logo: + +\ :mod:`pyams_content.shared.logo` package +========================================== + +.. automodule:: pyams_content.shared.logo + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.logo.\ ``manager`` +--------------------------------------- + +.. automodule:: pyams_content.shared.logo.manager + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.logo.\ ``paragraph`` +----------------------------------------- + +.. automodule:: pyams_content.shared.logo.paragraph + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.logo.interfaces + pyams_content.shared.logo.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.logo.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.logo.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.shared.logo.zmi: + +\ :mod:`pyams_content.shared.logo.zmi` package +============================================== + +.. automodule:: pyams_content.shared.logo.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.logo.zmi.\ ``paragraph`` +--------------------------------------------- + +.. automodule:: pyams_content.shared.logo.zmi.paragraph + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.logo.zmi.\ ``properties`` +---------------------------------------------- + +.. automodule:: pyams_content.shared.logo.zmi.properties + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.news.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.news.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.shared.news.interfaces: + +\ :mod:`pyams_content.shared.news.interfaces` package +===================================================== + +.. automodule:: pyams_content.shared.news.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.news.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.news.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.shared.news: + +\ :mod:`pyams_content.shared.news` package +========================================== + +.. automodule:: pyams_content.shared.news + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.news.\ ``manager`` +--------------------------------------- + +.. automodule:: pyams_content.shared.news.manager + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.news.interfaces + pyams_content.shared.news.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.news.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.news.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.shared.news.zmi: + +\ :mod:`pyams_content.shared.news.zmi` package +============================================== + +.. automodule:: pyams_content.shared.news.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,24 @@ +.. _pyams_content.shared: + +\ :mod:`pyams_content.shared` package +===================================== + +.. automodule:: pyams_content.shared + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.blog + 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 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.site.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.site.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.shared.site.interfaces: + +\ :mod:`pyams_content.shared.site.interfaces` package +===================================================== + +.. automodule:: pyams_content.shared.site.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.site.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.site.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,51 @@ +.. _pyams_content.shared.site: + +\ :mod:`pyams_content.shared.site` package +========================================== + +.. automodule:: pyams_content.shared.site + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.site.\ ``container`` +----------------------------------------- + +.. automodule:: pyams_content.shared.site.container + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.site.\ ``folder`` +-------------------------------------- + +.. automodule:: pyams_content.shared.site.folder + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.site.\ ``link`` +------------------------------------ + +.. automodule:: pyams_content.shared.site.link + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.site.\ ``manager`` +--------------------------------------- + +.. automodule:: pyams_content.shared.site.manager + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.site.interfaces + pyams_content.shared.site.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.site.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.site.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,50 @@ +.. _pyams_content.shared.site.zmi: + +\ :mod:`pyams_content.shared.site.zmi` package +============================================== + +.. automodule:: pyams_content.shared.site.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.site.zmi.\ ``container`` +--------------------------------------------- + +.. automodule:: pyams_content.shared.site.zmi.container + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.site.zmi.\ ``folder`` +------------------------------------------ + +.. automodule:: pyams_content.shared.site.zmi.folder + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.site.zmi.\ ``link`` +---------------------------------------- + +.. automodule:: pyams_content.shared.site.zmi.link + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.site.zmi.\ ``manager`` +------------------------------------------- + +.. automodule:: pyams_content.shared.site.zmi.manager + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.site.zmi.widget + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.site.zmi.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.site.zmi.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.shared.site.zmi.widget: + +\ :mod:`pyams_content.shared.site.zmi.widget` package +===================================================== + +.. automodule:: pyams_content.shared.site.zmi.widget + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.site.zmi.widget.\ ``interfaces`` +----------------------------------------------------- + +.. automodule:: pyams_content.shared.site.zmi.widget.interfaces + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.view.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.view.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.shared.view.interfaces: + +\ :mod:`pyams_content.shared.view.interfaces` package +===================================================== + +.. automodule:: pyams_content.shared.view.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.view.portlet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.view.portlet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,26 @@ +.. _pyams_content.shared.view.portlet: + +\ :mod:`pyams_content.shared.view.portlet` package +================================================== + +.. automodule:: pyams_content.shared.view.portlet + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.view.portlet.\ ``interfaces`` +-------------------------------------------------- + +.. automodule:: pyams_content.shared.view.portlet.interfaces + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.view.portlet.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.view.portlet.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.view.portlet.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.shared.view.portlet.zmi: + +\ :mod:`pyams_content.shared.view.portlet.zmi` package +====================================================== + +.. automodule:: pyams_content.shared.view.portlet.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.view.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.view.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,44 @@ +.. _pyams_content.shared.view: + +\ :mod:`pyams_content.shared.view` package +========================================== + +.. automodule:: pyams_content.shared.view + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.view.\ ``manager`` +--------------------------------------- + +.. automodule:: pyams_content.shared.view.manager + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.view.\ ``reference`` +----------------------------------------- + +.. automodule:: pyams_content.shared.view.reference + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.view.\ ``theme`` +------------------------------------- + +.. automodule:: pyams_content.shared.view.theme + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.shared.view.interfaces + pyams_content.shared.view.portlet + pyams_content.shared.view.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.shared.view.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.shared.view.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_content.shared.view.zmi: + +\ :mod:`pyams_content.shared.view.zmi` package +============================================== + +.. automodule:: pyams_content.shared.view.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.view.zmi.\ ``properties`` +---------------------------------------------- + +.. automodule:: pyams_content.shared.view.zmi.properties + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.view.zmi.\ ``reference`` +--------------------------------------------- + +.. automodule:: pyams_content.shared.view.zmi.reference + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.view.zmi.\ ``render`` +------------------------------------------ + +.. automodule:: pyams_content.shared.view.zmi.render + :members: + :undoc-members: + :show-inheritance: + +pyams_content.shared.view.zmi.\ ``theme`` +----------------------------------------- + +.. automodule:: pyams_content.shared.view.zmi.theme + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,26 @@ +.. _pyams_content.skin: + +\ :mod:`pyams_content.skin` package +=================================== + +.. automodule:: pyams_content.skin + :members: + :undoc-members: + :show-inheritance: + +pyams_content.skin.\ ``routes`` +------------------------------- + +.. automodule:: pyams_content.skin.routes + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.skin.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.skin.zmi.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.skin.zmi.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.skin.zmi.interfaces: + +\ :mod:`pyams_content.skin.zmi.interfaces` package +================================================== + +.. automodule:: pyams_content.skin.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.skin.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.skin.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.skin.zmi: + +\ :mod:`pyams_content.skin.zmi` package +======================================= + +.. automodule:: pyams_content.skin.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.skin.zmi.\ ``tinymce`` +------------------------------------ + +.. automodule:: pyams_content.skin.zmi.tinymce + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.skin.zmi.interfaces + pyams_content.skin.zmi.viewlet + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.skin.zmi.viewlet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.skin.zmi.viewlet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,17 @@ +.. _pyams_content.skin.zmi.viewlet: + +\ :mod:`pyams_content.skin.zmi.viewlet` package +=============================================== + +.. automodule:: pyams_content.skin.zmi.viewlet + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_content.skin.zmi.viewlet.toplinks + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.skin.zmi.viewlet.toplinks.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.skin.zmi.viewlet.toplinks.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content.skin.zmi.viewlet.toplinks: + +\ :mod:`pyams_content.skin.zmi.viewlet.toplinks` package +======================================================== + +.. automodule:: pyams_content.skin.zmi.viewlet.toplinks + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content.tests: + +\ :mod:`pyams_content.tests` package +==================================== + +.. automodule:: pyams_content.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_content.tests.\ ``test_utilsdocs`` +---------------------------------------- + +.. automodule:: pyams_content.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_content.tests.\ ``test_utilsdocstrings`` +---------------------------------------------- + +.. automodule:: pyams_content.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.workflow.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.workflow.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,50 @@ +.. _pyams_content.workflow: + +\ :mod:`pyams_content.workflow` package +======================================= + +.. automodule:: pyams_content.workflow + :members: + :undoc-members: + :show-inheritance: + +pyams_content.workflow.\ ``basic`` +---------------------------------- + +.. automodule:: pyams_content.workflow.basic + :members: + :undoc-members: + :show-inheritance: + +pyams_content.workflow.\ ``interfaces`` +--------------------------------------- + +.. automodule:: pyams_content.workflow.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_content.workflow.\ ``notify`` +----------------------------------- + +.. automodule:: pyams_content.workflow.notify + :members: + :undoc-members: + :show-inheritance: + +pyams_content.workflow.\ ``task`` +--------------------------------- + +.. automodule:: pyams_content.workflow.task + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content.workflow.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content/pyams_content.workflow.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content/pyams_content.workflow.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content.workflow.zmi: + +\ :mod:`pyams_content.workflow.zmi` package +=========================================== + +.. automodule:: pyams_content.workflow.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content.workflow.zmi.\ ``task`` +------------------------------------- + +.. automodule:: pyams_content.workflow.zmi.task + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content_es/pyams_content_es.component.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content_es/pyams_content_es.component.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,59 @@ +.. _pyams_content_es.component: + +\ :mod:`pyams_content_es.component` package +=========================================== + +.. automodule:: pyams_content_es.component + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.component.\ ``extfile`` +---------------------------------------- + +.. automodule:: pyams_content_es.component.extfile + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.component.\ ``gallery`` +---------------------------------------- + +.. automodule:: pyams_content_es.component.gallery + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.component.\ ``paragraph`` +------------------------------------------ + +.. automodule:: pyams_content_es.component.paragraph + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.component.\ ``theme`` +-------------------------------------- + +.. automodule:: pyams_content_es.component.theme + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.component.\ ``view`` +------------------------------------- + +.. automodule:: pyams_content_es.component.view + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.component.\ ``workflow`` +----------------------------------------- + +.. automodule:: pyams_content_es.component.workflow + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content_es/pyams_content_es.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content_es/pyams_content_es.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_content_es.interfaces: + +\ :mod:`pyams_content_es.interfaces` package +============================================ + +.. automodule:: pyams_content_es.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content_es/pyams_content_es.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content_es/pyams_content_es.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,70 @@ +.. _pyams_content_es: + +\ :mod:`pyams_content_es` package +================================= + +.. automodule:: pyams_content_es + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.\ ``document`` +------------------------------- + +.. automodule:: pyams_content_es.document + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.\ ``include`` +------------------------------ + +.. automodule:: pyams_content_es.include + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.\ ``index`` +---------------------------- + +.. automodule:: pyams_content_es.index + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.\ ``process`` +------------------------------ + +.. automodule:: pyams_content_es.process + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.\ ``site`` +--------------------------- + +.. automodule:: pyams_content_es.site + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.\ ``utility`` +------------------------------ + +.. automodule:: pyams_content_es.utility + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_content_es.component + pyams_content_es.interfaces + pyams_content_es.scripts + pyams_content_es.tests + pyams_content_es.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content_es/pyams_content_es.scripts.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content_es/pyams_content_es.scripts.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content_es.scripts: + +\ :mod:`pyams_content_es.scripts` package +========================================= + +.. automodule:: pyams_content_es.scripts + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.scripts.\ ``index`` +------------------------------------ + +.. automodule:: pyams_content_es.scripts.index + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content_es/pyams_content_es.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content_es/pyams_content_es.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_content_es.tests: + +\ :mod:`pyams_content_es.tests` package +======================================= + +.. automodule:: pyams_content_es.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.tests.\ ``test_utilsdocs`` +------------------------------------------- + +.. automodule:: pyams_content_es.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.tests.\ ``test_utilsdocstrings`` +------------------------------------------------- + +.. automodule:: pyams_content_es.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_content_es/pyams_content_es.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_content_es/pyams_content_es.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_content_es.zmi: + +\ :mod:`pyams_content_es.zmi` package +===================================== + +.. automodule:: pyams_content_es.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_content_es.zmi.\ ``test`` +------------------------------- + +.. automodule:: pyams_content_es.zmi.test + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.component.association.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.component.association.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_default_theme.component.association: + +\ :mod:`pyams_default_theme.component.association` package +========================================================== + +.. automodule:: pyams_default_theme.component.association + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.component.gallery.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.component.gallery.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_default_theme.component.gallery: + +\ :mod:`pyams_default_theme.component.gallery` package +====================================================== + +.. automodule:: pyams_default_theme.component.gallery + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.component.illustration.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.component.illustration.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_default_theme.component.illustration.interfaces: + +\ :mod:`pyams_default_theme.component.illustration.interfaces` package +====================================================================== + +.. automodule:: pyams_default_theme.component.illustration.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.component.illustration.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.component.illustration.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,17 @@ +.. _pyams_default_theme.component.illustration: + +\ :mod:`pyams_default_theme.component.illustration` package +=========================================================== + +.. automodule:: pyams_default_theme.component.illustration + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_default_theme.component.illustration.interfaces + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.component.paragraph.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.component.paragraph.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_default_theme.component.paragraph.interfaces: + +\ :mod:`pyams_default_theme.component.paragraph.interfaces` package +=================================================================== + +.. automodule:: pyams_default_theme.component.paragraph.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.interfaces.\ ``contact`` +---------------------------------------------------------------- + +.. automodule:: pyams_default_theme.component.paragraph.interfaces.contact + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.interfaces.\ ``frame`` +-------------------------------------------------------------- + +.. automodule:: pyams_default_theme.component.paragraph.interfaces.frame + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.interfaces.\ ``verbatim`` +----------------------------------------------------------------- + +.. automodule:: pyams_default_theme.component.paragraph.interfaces.verbatim + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.component.paragraph.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.component.paragraph.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,74 @@ +.. _pyams_default_theme.component.paragraph: + +\ :mod:`pyams_default_theme.component.paragraph` package +======================================================== + +.. automodule:: pyams_default_theme.component.paragraph + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.\ ``contact`` +----------------------------------------------------- + +.. automodule:: pyams_default_theme.component.paragraph.contact + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.\ ``frame`` +--------------------------------------------------- + +.. automodule:: pyams_default_theme.component.paragraph.frame + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.\ ``header`` +---------------------------------------------------- + +.. automodule:: pyams_default_theme.component.paragraph.header + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.\ ``html`` +-------------------------------------------------- + +.. automodule:: pyams_default_theme.component.paragraph.html + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.\ ``keypoint`` +------------------------------------------------------ + +.. automodule:: pyams_default_theme.component.paragraph.keypoint + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.\ ``verbatim`` +------------------------------------------------------ + +.. automodule:: pyams_default_theme.component.paragraph.verbatim + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.component.paragraph.\ ``video`` +--------------------------------------------------- + +.. automodule:: pyams_default_theme.component.paragraph.video + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_default_theme.component.paragraph.interfaces + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.component.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.component.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,21 @@ +.. _pyams_default_theme.component: + +\ :mod:`pyams_default_theme.component` package +============================================== + +.. automodule:: pyams_default_theme.component + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_default_theme.component.association + pyams_default_theme.component.gallery + pyams_default_theme.component.illustration + pyams_default_theme.component.paragraph + pyams_default_theme.component.video + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.component.video.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.component.video.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_default_theme.component.video: + +\ :mod:`pyams_default_theme.component.video` package +==================================================== + +.. automodule:: pyams_default_theme.component.video + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.features.footer.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.features.footer.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_default_theme.features.footer: + +\ :mod:`pyams_default_theme.features.footer` package +==================================================== + +.. automodule:: pyams_default_theme.features.footer + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.features.header.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.features.header.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_default_theme.features.header: + +\ :mod:`pyams_default_theme.features.header` package +==================================================== + +.. automodule:: pyams_default_theme.features.header + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.features.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.features.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,18 @@ +.. _pyams_default_theme.features: + +\ :mod:`pyams_default_theme.features` package +============================================= + +.. automodule:: pyams_default_theme.features + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_default_theme.features.footer + pyams_default_theme.features.header + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,53 @@ +.. _pyams_default_theme: + +\ :mod:`pyams_default_theme` package +==================================== + +.. automodule:: pyams_default_theme + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.\ ``include`` +--------------------------------- + +.. automodule:: pyams_default_theme.include + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.\ ``layer`` +------------------------------- + +.. automodule:: pyams_default_theme.layer + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.\ ``page`` +------------------------------ + +.. automodule:: pyams_default_theme.page + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.\ ``skin`` +------------------------------ + +.. automodule:: pyams_default_theme.skin + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_default_theme.component + pyams_default_theme.features + pyams_default_theme.shared + pyams_default_theme.tests + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.imagemap.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.imagemap.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_default_theme.shared.imagemap: + +\ :mod:`pyams_default_theme.shared.imagemap` package +==================================================== + +.. automodule:: pyams_default_theme.shared.imagemap + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.logo.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.logo.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_default_theme.shared.logo: + +\ :mod:`pyams_default_theme.shared.logo` package +================================================ + +.. automodule:: pyams_default_theme.shared.logo + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,28 @@ +.. _pyams_default_theme.shared: + +\ :mod:`pyams_default_theme.shared` package +=========================================== + +.. automodule:: pyams_default_theme.shared + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.shared.\ ``common`` +--------------------------------------- + +.. automodule:: pyams_default_theme.shared.common + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_default_theme.shared.imagemap + pyams_default_theme.shared.logo + pyams_default_theme.shared.view + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.view.portlet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.view.portlet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_default_theme.shared.view.portlet: + +\ :mod:`pyams_default_theme.shared.view.portlet` package +======================================================== + +.. automodule:: pyams_default_theme.shared.view.portlet + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.view.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.shared.view.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,17 @@ +.. _pyams_default_theme.shared.view: + +\ :mod:`pyams_default_theme.shared.view` package +================================================ + +.. automodule:: pyams_default_theme.shared.view + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_default_theme.shared.view.portlet + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_default_theme/pyams_default_theme.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_default_theme/pyams_default_theme.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_default_theme.tests: + +\ :mod:`pyams_default_theme.tests` package +========================================== + +.. automodule:: pyams_default_theme.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.tests.\ ``test_utilsdocs`` +---------------------------------------------- + +.. automodule:: pyams_default_theme.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_default_theme.tests.\ ``test_utilsdocstrings`` +---------------------------------------------------- + +.. automodule:: pyams_default_theme.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_file/pyams_file.archive.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_file/pyams_file.archive.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_file.archive: + +\ :mod:`pyams_file.archive` package +=================================== + +.. automodule:: pyams_file.archive + :members: + :undoc-members: + :show-inheritance: + +pyams_file.archive.\ ``bz2`` +---------------------------- + +.. automodule:: pyams_file.archive.bz2 + :members: + :undoc-members: + :show-inheritance: + +pyams_file.archive.\ ``gz`` +--------------------------- + +.. automodule:: pyams_file.archive.gz + :members: + :undoc-members: + :show-inheritance: + +pyams_file.archive.\ ``tar`` +---------------------------- + +.. automodule:: pyams_file.archive.tar + :members: + :undoc-members: + :show-inheritance: + +pyams_file.archive.\ ``zip`` +---------------------------- + +.. automodule:: pyams_file.archive.zip + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_file/pyams_file.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_file/pyams_file.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_file.interfaces: + +\ :mod:`pyams_file.interfaces` package +====================================== + +.. automodule:: pyams_file.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_file.interfaces.\ ``archive`` +----------------------------------- + +.. automodule:: pyams_file.interfaces.archive + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_file/pyams_file.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_file/pyams_file.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,79 @@ +.. _pyams_file: + +\ :mod:`pyams_file` package +=========================== + +.. automodule:: pyams_file + :members: + :undoc-members: + :show-inheritance: + +pyams_file.\ ``file`` +--------------------- + +.. automodule:: pyams_file.file + :members: + :undoc-members: + :show-inheritance: + +pyams_file.\ ``image`` +---------------------- + +.. automodule:: pyams_file.image + :members: + :undoc-members: + :show-inheritance: + +pyams_file.\ ``include`` +------------------------ + +.. automodule:: pyams_file.include + :members: + :undoc-members: + :show-inheritance: + +pyams_file.\ ``property`` +------------------------- + +.. automodule:: pyams_file.property + :members: + :undoc-members: + :show-inheritance: + +pyams_file.\ ``schema`` +----------------------- + +.. automodule:: pyams_file.schema + :members: + :undoc-members: + :show-inheritance: + +pyams_file.\ ``thumbnail`` +-------------------------- + +.. automodule:: pyams_file.thumbnail + :members: + :undoc-members: + :show-inheritance: + +pyams_file.\ ``watermark`` +-------------------------- + +.. automodule:: pyams_file.watermark + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_file.archive + pyams_file.interfaces + pyams_file.tests + pyams_file.views + pyams_file.widget + pyams_file.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_file/pyams_file.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_file/pyams_file.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_file.tests: + +\ :mod:`pyams_file.tests` package +================================= + +.. automodule:: pyams_file.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_file.tests.\ ``test_utilsdocs`` +------------------------------------- + +.. automodule:: pyams_file.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_file.tests.\ ``test_utilsdocstrings`` +------------------------------------------- + +.. automodule:: pyams_file.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_file/pyams_file.views.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_file/pyams_file.views.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_file.views: + +\ :mod:`pyams_file.views` package +================================= + +.. automodule:: pyams_file.views + :members: + :undoc-members: + :show-inheritance: + +pyams_file.views.\ ``file`` +--------------------------- + +.. automodule:: pyams_file.views.file + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_file/pyams_file.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_file/pyams_file.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_file.widget: + +\ :mod:`pyams_file.widget` package +================================== + +.. automodule:: pyams_file.widget + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_file/pyams_file.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_file/pyams_file.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_file.zmi: + +\ :mod:`pyams_file.zmi` package +=============================== + +.. automodule:: pyams_file.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_file.zmi.\ ``file`` +------------------------- + +.. automodule:: pyams_file.zmi.file + :members: + :undoc-members: + :show-inheritance: + +pyams_file.zmi.\ ``image`` +-------------------------- + +.. automodule:: pyams_file.zmi.image + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_form/pyams_form.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_form/pyams_form.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_form.interfaces: + +\ :mod:`pyams_form.interfaces` package +====================================== + +.. automodule:: pyams_form.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_form.interfaces.\ ``form`` +-------------------------------- + +.. automodule:: pyams_form.interfaces.form + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_form/pyams_form.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_form/pyams_form.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,92 @@ +.. _pyams_form: + +\ :mod:`pyams_form` package +=========================== + +.. automodule:: pyams_form + :members: + :undoc-members: + :show-inheritance: + +pyams_form.\ ``form`` +--------------------- + +.. automodule:: pyams_form.form + :members: + :undoc-members: + :show-inheritance: + +pyams_form.\ ``group`` +---------------------- + +.. automodule:: pyams_form.group + :members: + :undoc-members: + :show-inheritance: + +pyams_form.\ ``help`` +--------------------- + +.. automodule:: pyams_form.help + :members: + :undoc-members: + :show-inheritance: + +pyams_form.\ ``include`` +------------------------ + +.. automodule:: pyams_form.include + :members: + :undoc-members: + :show-inheritance: + +pyams_form.\ ``schema`` +----------------------- + +.. automodule:: pyams_form.schema + :members: + :undoc-members: + :show-inheritance: + +pyams_form.\ ``search`` +----------------------- + +.. automodule:: pyams_form.search + :members: + :undoc-members: + :show-inheritance: + +pyams_form.\ ``security`` +------------------------- + +.. automodule:: pyams_form.security + :members: + :undoc-members: + :show-inheritance: + +pyams_form.\ ``terms`` +---------------------- + +.. automodule:: pyams_form.terms + :members: + :undoc-members: + :show-inheritance: + +pyams_form.\ ``viewlet`` +------------------------ + +.. automodule:: pyams_form.viewlet + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_form.interfaces + pyams_form.tests + pyams_form.widget + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_form/pyams_form.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_form/pyams_form.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_form.tests: + +\ :mod:`pyams_form.tests` package +================================= + +.. automodule:: pyams_form.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_form.tests.\ ``test_utilsdocs`` +------------------------------------- + +.. automodule:: pyams_form.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_form.tests.\ ``test_utilsdocstrings`` +------------------------------------------- + +.. automodule:: pyams_form.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_form/pyams_form.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_form/pyams_form.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_form.widget: + +\ :mod:`pyams_form.widget` package +================================== + +.. automodule:: pyams_form.widget + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_gis/pyams_gis.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_gis/pyams_gis.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_gis.interfaces: + +\ :mod:`pyams_gis.interfaces` package +===================================== + +.. automodule:: pyams_gis.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.interfaces.\ ``configuration`` +---------------------------------------- + +.. automodule:: pyams_gis.interfaces.configuration + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.interfaces.\ ``layer`` +-------------------------------- + +.. automodule:: pyams_gis.interfaces.layer + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.interfaces.\ ``utility`` +---------------------------------- + +.. automodule:: pyams_gis.interfaces.utility + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.interfaces.\ ``widget`` +--------------------------------- + +.. automodule:: pyams_gis.interfaces.widget + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_gis/pyams_gis.rpc.json.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_gis/pyams_gis.rpc.json.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_gis.rpc.json: + +\ :mod:`pyams_gis.rpc.json` package +=================================== + +.. automodule:: pyams_gis.rpc.json + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_gis/pyams_gis.rpc.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_gis/pyams_gis.rpc.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,17 @@ +.. _pyams_gis.rpc: + +\ :mod:`pyams_gis.rpc` package +============================== + +.. automodule:: pyams_gis.rpc + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_gis.rpc.json + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_gis/pyams_gis.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_gis/pyams_gis.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,94 @@ +.. _pyams_gis: + +\ :mod:`pyams_gis` package +========================== + +.. automodule:: pyams_gis + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.\ ``area`` +-------------------- + +.. automodule:: pyams_gis.area + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.\ ``configuration`` +----------------------------- + +.. automodule:: pyams_gis.configuration + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.\ ``include`` +----------------------- + +.. automodule:: pyams_gis.include + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.\ ``layer`` +--------------------- + +.. automodule:: pyams_gis.layer + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.\ ``point`` +--------------------- + +.. automodule:: pyams_gis.point + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.\ ``schema`` +---------------------- + +.. automodule:: pyams_gis.schema + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.\ ``site`` +-------------------- + +.. automodule:: pyams_gis.site + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.\ ``transform`` +------------------------- + +.. automodule:: pyams_gis.transform + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.\ ``utility`` +----------------------- + +.. automodule:: pyams_gis.utility + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_gis.interfaces + pyams_gis.rpc + pyams_gis.tests + pyams_gis.widget + pyams_gis.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_gis/pyams_gis.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_gis/pyams_gis.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_gis.tests: + +\ :mod:`pyams_gis.tests` package +================================ + +.. automodule:: pyams_gis.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.tests.\ ``test_utilsdocs`` +------------------------------------ + +.. automodule:: pyams_gis.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.tests.\ ``test_utilsdocstrings`` +------------------------------------------ + +.. automodule:: pyams_gis.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_gis/pyams_gis.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_gis/pyams_gis.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_gis.widget: + +\ :mod:`pyams_gis.widget` package +================================= + +.. automodule:: pyams_gis.widget + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.widget.\ ``area`` +--------------------------- + +.. automodule:: pyams_gis.widget.area + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.widget.\ ``point`` +---------------------------- + +.. automodule:: pyams_gis.widget.point + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_gis/pyams_gis.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_gis/pyams_gis.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_gis.zmi: + +\ :mod:`pyams_gis.zmi` package +============================== + +.. automodule:: pyams_gis.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.zmi.\ ``interfaces`` +------------------------------ + +.. automodule:: pyams_gis.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.zmi.\ ``layer`` +------------------------- + +.. automodule:: pyams_gis.zmi.layer + :members: + :undoc-members: + :show-inheritance: + +pyams_gis.zmi.\ ``utility`` +--------------------------- + +.. automodule:: pyams_gis.zmi.utility + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_i18n/pyams_i18n.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_i18n/pyams_i18n.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_i18n.interfaces: + +\ :mod:`pyams_i18n.interfaces` package +====================================== + +.. automodule:: pyams_i18n.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.interfaces.\ ``schema`` +---------------------------------- + +.. automodule:: pyams_i18n.interfaces.schema + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.interfaces.\ ``widget`` +---------------------------------- + +.. automodule:: pyams_i18n.interfaces.widget + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_i18n/pyams_i18n.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_i18n/pyams_i18n.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,116 @@ +.. _pyams_i18n: + +\ :mod:`pyams_i18n` package +=========================== + +.. automodule:: pyams_i18n + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``attr`` +--------------------- + +.. automodule:: pyams_i18n.attr + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``column`` +----------------------- + +.. automodule:: pyams_i18n.column + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``content`` +------------------------ + +.. automodule:: pyams_i18n.content + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``expr`` +--------------------- + +.. automodule:: pyams_i18n.expr + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``include`` +------------------------ + +.. automodule:: pyams_i18n.include + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``index`` +---------------------- + +.. automodule:: pyams_i18n.index + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``language`` +------------------------- + +.. automodule:: pyams_i18n.language + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``negotiator`` +--------------------------- + +.. automodule:: pyams_i18n.negotiator + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``property`` +------------------------- + +.. automodule:: pyams_i18n.property + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``schema`` +----------------------- + +.. automodule:: pyams_i18n.schema + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``site`` +--------------------- + +.. automodule:: pyams_i18n.site + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.\ ``vocabulary`` +--------------------------- + +.. automodule:: pyams_i18n.vocabulary + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_i18n.interfaces + pyams_i18n.widget + pyams_i18n.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_i18n/pyams_i18n.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_i18n/pyams_i18n.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_i18n.widget: + +\ :mod:`pyams_i18n.widget` package +================================== + +.. automodule:: pyams_i18n.widget + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_i18n/pyams_i18n.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_i18n/pyams_i18n.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_i18n.zmi: + +\ :mod:`pyams_i18n.zmi` package +=============================== + +.. automodule:: pyams_i18n.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.zmi.\ ``language`` +----------------------------- + +.. automodule:: pyams_i18n.zmi.language + :members: + :undoc-members: + :show-inheritance: + +pyams_i18n.zmi.\ ``negotiator`` +------------------------------- + +.. automodule:: pyams_i18n.zmi.negotiator + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_ldap/pyams_ldap.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_ldap/pyams_ldap.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_ldap.interfaces: + +\ :mod:`pyams_ldap.interfaces` package +====================================== + +.. automodule:: pyams_ldap.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_ldap/pyams_ldap.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_ldap/pyams_ldap.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,36 @@ +.. _pyams_ldap: + +\ :mod:`pyams_ldap` package +=========================== + +.. automodule:: pyams_ldap + :members: + :undoc-members: + :show-inheritance: + +pyams_ldap.\ ``plugin`` +----------------------- + +.. automodule:: pyams_ldap.plugin + :members: + :undoc-members: + :show-inheritance: + +pyams_ldap.\ ``query`` +---------------------- + +.. automodule:: pyams_ldap.query + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_ldap.interfaces + pyams_ldap.tests + pyams_ldap.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_ldap/pyams_ldap.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_ldap/pyams_ldap.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_ldap.tests: + +\ :mod:`pyams_ldap.tests` package +================================= + +.. automodule:: pyams_ldap.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_ldap.tests.\ ``test_utilsdocs`` +------------------------------------- + +.. automodule:: pyams_ldap.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_ldap.tests.\ ``test_utilsdocstrings`` +------------------------------------------- + +.. automodule:: pyams_ldap.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_ldap/pyams_ldap.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_ldap/pyams_ldap.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_ldap.zmi: + +\ :mod:`pyams_ldap.zmi` package +=============================== + +.. automodule:: pyams_ldap.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_ldap.zmi.\ ``plugin`` +--------------------------- + +.. automodule:: pyams_ldap.zmi.plugin + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_mail/pyams_mail.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_mail/pyams_mail.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_mail.interfaces: + +\ :mod:`pyams_mail.interfaces` package +====================================== + +.. automodule:: pyams_mail.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_mail/pyams_mail.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_mail/pyams_mail.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_mail: + +\ :mod:`pyams_mail` package +=========================== + +.. automodule:: pyams_mail + :members: + :undoc-members: + :show-inheritance: + +pyams_mail.\ ``include`` +------------------------ + +.. automodule:: pyams_mail.include + :members: + :undoc-members: + :show-inheritance: + +pyams_mail.\ ``mailer`` +----------------------- + +.. automodule:: pyams_mail.mailer + :members: + :undoc-members: + :show-inheritance: + +pyams_mail.\ ``message`` +------------------------ + +.. automodule:: pyams_mail.message + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_mail.interfaces + pyams_mail.tests + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_mail/pyams_mail.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_mail/pyams_mail.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_mail.tests: + +\ :mod:`pyams_mail.tests` package +================================= + +.. automodule:: pyams_mail.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_mail.tests.\ ``test_utilsdocs`` +------------------------------------- + +.. automodule:: pyams_mail.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_mail.tests.\ ``test_utilsdocstrings`` +------------------------------------------- + +.. automodule:: pyams_mail.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_media/pyams_media.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_media/pyams_media.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_media.interfaces: + +\ :mod:`pyams_media.interfaces` package +======================================= + +.. automodule:: pyams_media.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_media/pyams_media.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_media/pyams_media.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,109 @@ +.. _pyams_media: + +\ :mod:`pyams_media` package +============================ + +.. automodule:: pyams_media + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``audio`` +----------------------- + +.. automodule:: pyams_media.audio + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``converter`` +--------------------------- + +.. automodule:: pyams_media.converter + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``ffbase`` +------------------------ + +.. automodule:: pyams_media.ffbase + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``ffdocument`` +---------------------------- + +.. automodule:: pyams_media.ffdocument + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``ffexception`` +----------------------------- + +.. automodule:: pyams_media.ffexception + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``include`` +------------------------- + +.. automodule:: pyams_media.include + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``media`` +----------------------- + +.. automodule:: pyams_media.media + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``process`` +------------------------- + +.. automodule:: pyams_media.process + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``site`` +---------------------- + +.. automodule:: pyams_media.site + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``utility`` +------------------------- + +.. automodule:: pyams_media.utility + :members: + :undoc-members: + :show-inheritance: + +pyams_media.\ ``video`` +----------------------- + +.. automodule:: pyams_media.video + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_media.interfaces + pyams_media.skin + pyams_media.tests + pyams_media.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_media/pyams_media.skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_media/pyams_media.skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_media.skin: + +\ :mod:`pyams_media.skin` package +================================= + +.. automodule:: pyams_media.skin + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_media/pyams_media.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_media/pyams_media.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_media.tests: + +\ :mod:`pyams_media.tests` package +================================== + +.. automodule:: pyams_media.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_media.tests.\ ``test_utilsdocs`` +-------------------------------------- + +.. automodule:: pyams_media.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_media.tests.\ ``test_utilsdocstrings`` +-------------------------------------------- + +.. automodule:: pyams_media.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_media/pyams_media.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_media/pyams_media.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_media.zmi: + +\ :mod:`pyams_media.zmi` package +================================ + +.. automodule:: pyams_media.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_media.zmi.\ ``audio`` +--------------------------- + +.. automodule:: pyams_media.zmi.audio + :members: + :undoc-members: + :show-inheritance: + +pyams_media.zmi.\ ``interfaces`` +-------------------------------- + +.. automodule:: pyams_media.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_media.zmi.\ ``media`` +--------------------------- + +.. automodule:: pyams_media.zmi.media + :members: + :undoc-members: + :show-inheritance: + +pyams_media.zmi.\ ``video`` +--------------------------- + +.. automodule:: pyams_media.zmi.video + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify/pyams_notify.handlers.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify/pyams_notify.handlers.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_notify.handlers: + +\ :mod:`pyams_notify.handlers` package +====================================== + +.. automodule:: pyams_notify.handlers + :members: + :undoc-members: + :show-inheritance: + +pyams_notify.handlers.\ ``login`` +--------------------------------- + +.. automodule:: pyams_notify.handlers.login + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify/pyams_notify.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify/pyams_notify.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_notify.interfaces: + +\ :mod:`pyams_notify.interfaces` package +======================================== + +.. automodule:: pyams_notify.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify/pyams_notify.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify/pyams_notify.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,47 @@ +.. _pyams_notify: + +\ :mod:`pyams_notify` package +============================= + +.. automodule:: pyams_notify + :members: + :undoc-members: + :show-inheritance: + +pyams_notify.\ ``event`` +------------------------ + +.. automodule:: pyams_notify.event + :members: + :undoc-members: + :show-inheritance: + +pyams_notify.\ ``include`` +-------------------------- + +.. automodule:: pyams_notify.include + :members: + :undoc-members: + :show-inheritance: + +pyams_notify.\ ``resources`` +---------------------------- + +.. automodule:: pyams_notify.resources + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_notify.handlers + pyams_notify.interfaces + pyams_notify.skin + pyams_notify.tests + pyams_notify.viewlet + pyams_notify.views + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify/pyams_notify.skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify/pyams_notify.skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_notify.skin: + +\ :mod:`pyams_notify.skin` package +================================== + +.. automodule:: pyams_notify.skin + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify/pyams_notify.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify/pyams_notify.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_notify.tests: + +\ :mod:`pyams_notify.tests` package +=================================== + +.. automodule:: pyams_notify.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_notify.tests.\ ``test_utilsdocs`` +--------------------------------------- + +.. automodule:: pyams_notify.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_notify.tests.\ ``test_utilsdocstrings`` +--------------------------------------------- + +.. automodule:: pyams_notify.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify/pyams_notify.viewlet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify/pyams_notify.viewlet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_notify.viewlet: + +\ :mod:`pyams_notify.viewlet` package +===================================== + +.. automodule:: pyams_notify.viewlet + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify/pyams_notify.views.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify/pyams_notify.views.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_notify.views: + +\ :mod:`pyams_notify.views` package +=================================== + +.. automodule:: pyams_notify.views + :members: + :undoc-members: + :show-inheritance: + +pyams_notify.views.\ ``context`` +-------------------------------- + +.. automodule:: pyams_notify.views.context + :members: + :undoc-members: + :show-inheritance: + +pyams_notify.views.\ ``notification`` +------------------------------------- + +.. automodule:: pyams_notify.views.notification + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify_ws/pyams_notify_ws.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify_ws/pyams_notify_ws.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_notify_ws.interfaces: + +\ :mod:`pyams_notify_ws.interfaces` package +=========================================== + +.. automodule:: pyams_notify_ws.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify_ws/pyams_notify_ws.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify_ws/pyams_notify_ws.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_notify_ws: + +\ :mod:`pyams_notify_ws` package +================================ + +.. automodule:: pyams_notify_ws + :members: + :undoc-members: + :show-inheritance: + +pyams_notify_ws.\ ``include`` +----------------------------- + +.. automodule:: pyams_notify_ws.include + :members: + :undoc-members: + :show-inheritance: + +pyams_notify_ws.\ ``notify`` +---------------------------- + +.. automodule:: pyams_notify_ws.notify + :members: + :undoc-members: + :show-inheritance: + +pyams_notify_ws.\ ``subscribe`` +------------------------------- + +.. automodule:: pyams_notify_ws.subscribe + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_notify_ws.interfaces + pyams_notify_ws.tests + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_notify_ws/pyams_notify_ws.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_notify_ws/pyams_notify_ws.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_notify_ws.tests: + +\ :mod:`pyams_notify_ws.tests` package +====================================== + +.. automodule:: pyams_notify_ws.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_notify_ws.tests.\ ``test_utilsdocs`` +------------------------------------------ + +.. automodule:: pyams_notify_ws.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_notify_ws.tests.\ ``test_utilsdocstrings`` +------------------------------------------------ + +.. automodule:: pyams_notify_ws.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_pagelet/pyams_pagelet.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_pagelet/pyams_pagelet.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_pagelet.interfaces: + +\ :mod:`pyams_pagelet.interfaces` package +========================================= + +.. automodule:: pyams_pagelet.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_pagelet/pyams_pagelet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_pagelet/pyams_pagelet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_pagelet: + +\ :mod:`pyams_pagelet` package +============================== + +.. automodule:: pyams_pagelet + :members: + :undoc-members: + :show-inheritance: + +pyams_pagelet.\ ``metaconfigure`` +--------------------------------- + +.. automodule:: pyams_pagelet.metaconfigure + :members: + :undoc-members: + :show-inheritance: + +pyams_pagelet.\ ``metadirectives`` +---------------------------------- + +.. automodule:: pyams_pagelet.metadirectives + :members: + :undoc-members: + :show-inheritance: + +pyams_pagelet.\ ``pagelet`` +--------------------------- + +.. automodule:: pyams_pagelet.pagelet + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_pagelet.interfaces + pyams_pagelet.tests + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_pagelet/pyams_pagelet.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_pagelet/pyams_pagelet.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_pagelet.tests: + +\ :mod:`pyams_pagelet.tests` package +==================================== + +.. automodule:: pyams_pagelet.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_pagelet.tests.\ ``test_utilsdocs`` +---------------------------------------- + +.. automodule:: pyams_pagelet.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_pagelet.tests.\ ``test_utilsdocstrings`` +---------------------------------------------- + +.. automodule:: pyams_pagelet.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_portal.interfaces: + +\ :mod:`pyams_portal.interfaces` package +======================================== + +.. automodule:: pyams_portal.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.content.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.content.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_portal.portlets.content: + +\ :mod:`pyams_portal.portlets.content` package +============================================== + +.. automodule:: pyams_portal.portlets.content + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.portlets.content.\ ``interfaces`` +---------------------------------------------- + +.. automodule:: pyams_portal.portlets.content.interfaces + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_portal.portlets.content.skin + pyams_portal.portlets.content.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.content.skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.content.skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_portal.portlets.content.skin: + +\ :mod:`pyams_portal.portlets.content.skin` package +=================================================== + +.. automodule:: pyams_portal.portlets.content.skin + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.content.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.content.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_portal.portlets.content.zmi: + +\ :mod:`pyams_portal.portlets.content.zmi` package +================================================== + +.. automodule:: pyams_portal.portlets.content.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.html.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.html.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_portal.portlets.html: + +\ :mod:`pyams_portal.portlets.html` package +=========================================== + +.. automodule:: pyams_portal.portlets.html + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.portlets.html.\ ``interfaces`` +------------------------------------------- + +.. automodule:: pyams_portal.portlets.html.interfaces + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_portal.portlets.html.skin + pyams_portal.portlets.html.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.html.skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.html.skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_portal.portlets.html.skin: + +\ :mod:`pyams_portal.portlets.html.skin` package +================================================ + +.. automodule:: pyams_portal.portlets.html.skin + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.html.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.html.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_portal.portlets.html.zmi: + +\ :mod:`pyams_portal.portlets.html.zmi` package +=============================================== + +.. automodule:: pyams_portal.portlets.html.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.image.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.image.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_portal.portlets.image: + +\ :mod:`pyams_portal.portlets.image` package +============================================ + +.. automodule:: pyams_portal.portlets.image + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.portlets.image.\ ``interfaces`` +-------------------------------------------- + +.. automodule:: pyams_portal.portlets.image.interfaces + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_portal.portlets.image.skin + pyams_portal.portlets.image.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.image.skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.image.skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_portal.portlets.image.skin: + +\ :mod:`pyams_portal.portlets.image.skin` package +================================================= + +.. automodule:: pyams_portal.portlets.image.skin + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.image.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.image.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_portal.portlets.image.zmi: + +\ :mod:`pyams_portal.portlets.image.zmi` package +================================================ + +.. automodule:: pyams_portal.portlets.image.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.portlets.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.portlets.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_portal.portlets: + +\ :mod:`pyams_portal.portlets` package +====================================== + +.. automodule:: pyams_portal.portlets + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_portal.portlets.content + pyams_portal.portlets.html + pyams_portal.portlets.image + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,77 @@ +.. _pyams_portal: + +\ :mod:`pyams_portal` package +============================= + +.. automodule:: pyams_portal + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.\ ``include`` +-------------------------- + +.. automodule:: pyams_portal.include + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.\ ``page`` +----------------------- + +.. automodule:: pyams_portal.page + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.\ ``portlet`` +-------------------------- + +.. automodule:: pyams_portal.portlet + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.\ ``site`` +----------------------- + +.. automodule:: pyams_portal.site + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.\ ``slot`` +----------------------- + +.. automodule:: pyams_portal.slot + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.\ ``template`` +--------------------------- + +.. automodule:: pyams_portal.template + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.\ ``views`` +------------------------ + +.. automodule:: pyams_portal.views + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_portal.interfaces + pyams_portal.portlets + pyams_portal.tests + pyams_portal.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_portal.tests: + +\ :mod:`pyams_portal.tests` package +=================================== + +.. automodule:: pyams_portal.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.tests.\ ``test_utilsdocs`` +--------------------------------------- + +.. automodule:: pyams_portal.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.tests.\ ``test_utilsdocstrings`` +--------------------------------------------- + +.. automodule:: pyams_portal.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_portal/pyams_portal.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_portal/pyams_portal.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,59 @@ +.. _pyams_portal.zmi: + +\ :mod:`pyams_portal.zmi` package +================================= + +.. automodule:: pyams_portal.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.zmi.\ ``container`` +-------------------------------- + +.. automodule:: pyams_portal.zmi.container + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.zmi.\ ``interfaces`` +--------------------------------- + +.. automodule:: pyams_portal.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.zmi.\ ``layout`` +----------------------------- + +.. automodule:: pyams_portal.zmi.layout + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.zmi.\ ``page`` +--------------------------- + +.. automodule:: pyams_portal.zmi.page + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.zmi.\ ``portlet`` +------------------------------ + +.. automodule:: pyams_portal.zmi.portlet + :members: + :undoc-members: + :show-inheritance: + +pyams_portal.zmi.\ ``template`` +------------------------------- + +.. automodule:: pyams_portal.zmi.template + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_scheduler/pyams_scheduler.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_scheduler/pyams_scheduler.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_scheduler.interfaces: + +\ :mod:`pyams_scheduler.interfaces` package +=========================================== + +.. automodule:: pyams_scheduler.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.interfaces.\ ``ssh`` +------------------------------------ + +.. automodule:: pyams_scheduler.interfaces.ssh + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.interfaces.\ ``url`` +------------------------------------ + +.. automodule:: pyams_scheduler.interfaces.url + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.interfaces.\ ``zodb`` +------------------------------------- + +.. automodule:: pyams_scheduler.interfaces.zodb + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_scheduler/pyams_scheduler.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_scheduler/pyams_scheduler.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,92 @@ +.. _pyams_scheduler: + +\ :mod:`pyams_scheduler` package +================================ + +.. automodule:: pyams_scheduler + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.\ ``include`` +----------------------------- + +.. automodule:: pyams_scheduler.include + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.\ ``process`` +----------------------------- + +.. automodule:: pyams_scheduler.process + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.\ ``scheduler`` +------------------------------- + +.. automodule:: pyams_scheduler.scheduler + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.\ ``site`` +-------------------------- + +.. automodule:: pyams_scheduler.site + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.\ ``ssh`` +------------------------- + +.. automodule:: pyams_scheduler.ssh + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.\ ``task`` +-------------------------- + +.. automodule:: pyams_scheduler.task + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.\ ``trigger`` +----------------------------- + +.. automodule:: pyams_scheduler.trigger + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.\ ``url`` +------------------------- + +.. automodule:: pyams_scheduler.url + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.\ ``zodb`` +-------------------------- + +.. automodule:: pyams_scheduler.zodb + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_scheduler.interfaces + pyams_scheduler.tests + pyams_scheduler.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_scheduler/pyams_scheduler.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_scheduler/pyams_scheduler.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_scheduler.tests: + +\ :mod:`pyams_scheduler.tests` package +====================================== + +.. automodule:: pyams_scheduler.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.tests.\ ``test_utilsdocs`` +------------------------------------------ + +.. automodule:: pyams_scheduler.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.tests.\ ``test_utilsdocstrings`` +------------------------------------------------ + +.. automodule:: pyams_scheduler.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_scheduler/pyams_scheduler.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_scheduler/pyams_scheduler.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,59 @@ +.. _pyams_scheduler.zmi: + +\ :mod:`pyams_scheduler.zmi` package +==================================== + +.. automodule:: pyams_scheduler.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.zmi.\ ``interfaces`` +------------------------------------ + +.. automodule:: pyams_scheduler.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.zmi.\ ``scheduler`` +----------------------------------- + +.. automodule:: pyams_scheduler.zmi.scheduler + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.zmi.\ ``ssh`` +----------------------------- + +.. automodule:: pyams_scheduler.zmi.ssh + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.zmi.\ ``task`` +------------------------------ + +.. automodule:: pyams_scheduler.zmi.task + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.zmi.\ ``url`` +----------------------------- + +.. automodule:: pyams_scheduler.zmi.url + :members: + :undoc-members: + :show-inheritance: + +pyams_scheduler.zmi.\ ``zodb`` +------------------------------ + +.. automodule:: pyams_scheduler.zmi.zodb + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_security/pyams_security.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_security/pyams_security.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_security.interfaces: + +\ :mod:`pyams_security.interfaces` package +========================================== + +.. automodule:: pyams_security.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_security.interfaces.\ ``notification`` +-------------------------------------------- + +.. automodule:: pyams_security.interfaces.notification + :members: + :undoc-members: + :show-inheritance: + +pyams_security.interfaces.\ ``profile`` +--------------------------------------- + +.. automodule:: pyams_security.interfaces.profile + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_security/pyams_security.plugin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_security/pyams_security.plugin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,51 @@ +.. _pyams_security.plugin: + +\ :mod:`pyams_security.plugin` package +====================================== + +.. automodule:: pyams_security.plugin + :members: + :undoc-members: + :show-inheritance: + +pyams_security.plugin.\ ``admin`` +--------------------------------- + +.. automodule:: pyams_security.plugin.admin + :members: + :undoc-members: + :show-inheritance: + +pyams_security.plugin.\ ``group`` +--------------------------------- + +.. automodule:: pyams_security.plugin.group + :members: + :undoc-members: + :show-inheritance: + +pyams_security.plugin.\ ``http`` +-------------------------------- + +.. automodule:: pyams_security.plugin.http + :members: + :undoc-members: + :show-inheritance: + +pyams_security.plugin.\ ``social`` +---------------------------------- + +.. automodule:: pyams_security.plugin.social + :members: + :undoc-members: + :show-inheritance: + +pyams_security.plugin.\ ``userfolder`` +-------------------------------------- + +.. automodule:: pyams_security.plugin.userfolder + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_security/pyams_security.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_security/pyams_security.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,135 @@ +.. _pyams_security: + +\ :mod:`pyams_security` package +=============================== + +.. automodule:: pyams_security + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``credential`` +------------------------------- + +.. automodule:: pyams_security.credential + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``include`` +---------------------------- + +.. automodule:: pyams_security.include + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``index`` +-------------------------- + +.. automodule:: pyams_security.index + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``notification`` +--------------------------------- + +.. automodule:: pyams_security.notification + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``permission`` +------------------------------- + +.. automodule:: pyams_security.permission + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``principal`` +------------------------------ + +.. automodule:: pyams_security.principal + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``profile`` +---------------------------- + +.. automodule:: pyams_security.profile + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``property`` +----------------------------- + +.. automodule:: pyams_security.property + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``role`` +------------------------- + +.. automodule:: pyams_security.role + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``schema`` +--------------------------- + +.. automodule:: pyams_security.schema + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``security`` +----------------------------- + +.. automodule:: pyams_security.security + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``site`` +------------------------- + +.. automodule:: pyams_security.site + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``utility`` +---------------------------- + +.. automodule:: pyams_security.utility + :members: + :undoc-members: + :show-inheritance: + +pyams_security.\ ``vocabulary`` +------------------------------- + +.. automodule:: pyams_security.vocabulary + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_security.interfaces + pyams_security.plugin + pyams_security.tests + pyams_security.views + pyams_security.widget + pyams_security.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_security/pyams_security.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_security/pyams_security.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_security.tests: + +\ :mod:`pyams_security.tests` package +===================================== + +.. automodule:: pyams_security.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_security.tests.\ ``test_utilsdocs`` +----------------------------------------- + +.. automodule:: pyams_security.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_security.tests.\ ``test_utilsdocstrings`` +----------------------------------------------- + +.. automodule:: pyams_security.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_security/pyams_security.views.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_security/pyams_security.views.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_security.views: + +\ :mod:`pyams_security.views` package +===================================== + +.. automodule:: pyams_security.views + :members: + :undoc-members: + :show-inheritance: + +pyams_security.views.\ ``login`` +-------------------------------- + +.. automodule:: pyams_security.views.login + :members: + :undoc-members: + :show-inheritance: + +pyams_security.views.\ ``oauth`` +-------------------------------- + +.. automodule:: pyams_security.views.oauth + :members: + :undoc-members: + :show-inheritance: + +pyams_security.views.\ ``userfolder`` +------------------------------------- + +.. automodule:: pyams_security.views.userfolder + :members: + :undoc-members: + :show-inheritance: + +pyams_security.views.\ ``utility`` +---------------------------------- + +.. automodule:: pyams_security.views.utility + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_security/pyams_security.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_security/pyams_security.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_security.widget: + +\ :mod:`pyams_security.widget` package +====================================== + +.. automodule:: pyams_security.widget + :members: + :undoc-members: + :show-inheritance: + +pyams_security.widget.\ ``interfaces`` +-------------------------------------- + +.. automodule:: pyams_security.widget.interfaces + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_security/pyams_security.zmi.plugin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_security/pyams_security.zmi.plugin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_security.zmi.plugin: + +\ :mod:`pyams_security.zmi.plugin` package +========================================== + +.. automodule:: pyams_security.zmi.plugin + :members: + :undoc-members: + :show-inheritance: + +pyams_security.zmi.plugin.\ ``admin`` +------------------------------------- + +.. automodule:: pyams_security.zmi.plugin.admin + :members: + :undoc-members: + :show-inheritance: + +pyams_security.zmi.plugin.\ ``group`` +------------------------------------- + +.. automodule:: pyams_security.zmi.plugin.group + :members: + :undoc-members: + :show-inheritance: + +pyams_security.zmi.plugin.\ ``social`` +-------------------------------------- + +.. automodule:: pyams_security.zmi.plugin.social + :members: + :undoc-members: + :show-inheritance: + +pyams_security.zmi.plugin.\ ``userfolder`` +------------------------------------------ + +.. automodule:: pyams_security.zmi.plugin.userfolder + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_security/pyams_security.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_security/pyams_security.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,59 @@ +.. _pyams_security.zmi: + +\ :mod:`pyams_security.zmi` package +=================================== + +.. automodule:: pyams_security.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_security.zmi.\ ``interfaces`` +----------------------------------- + +.. automodule:: pyams_security.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_security.zmi.\ ``notification`` +------------------------------------- + +.. automodule:: pyams_security.zmi.notification + :members: + :undoc-members: + :show-inheritance: + +pyams_security.zmi.\ ``profile`` +-------------------------------- + +.. automodule:: pyams_security.zmi.profile + :members: + :undoc-members: + :show-inheritance: + +pyams_security.zmi.\ ``security`` +--------------------------------- + +.. automodule:: pyams_security.zmi.security + :members: + :undoc-members: + :show-inheritance: + +pyams_security.zmi.\ ``utility`` +-------------------------------- + +.. automodule:: pyams_security.zmi.utility + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_security.zmi.plugin + pyams_security.zmi.widget + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_security/pyams_security.zmi.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_security/pyams_security.zmi.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_security.zmi.widget: + +\ :mod:`pyams_security.zmi.widget` package +========================================== + +.. automodule:: pyams_security.zmi.widget + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_sequence/pyams_sequence.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_sequence/pyams_sequence.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_sequence.interfaces: + +\ :mod:`pyams_sequence.interfaces` package +========================================== + +.. automodule:: pyams_sequence.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_sequence/pyams_sequence.rpc.json.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_sequence/pyams_sequence.rpc.json.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_sequence.rpc.json: + +\ :mod:`pyams_sequence.rpc.json` package +======================================== + +.. automodule:: pyams_sequence.rpc.json + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_sequence/pyams_sequence.rpc.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_sequence/pyams_sequence.rpc.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,17 @@ +.. _pyams_sequence.rpc: + +\ :mod:`pyams_sequence.rpc` package +=================================== + +.. automodule:: pyams_sequence.rpc + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_sequence.rpc.json + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_sequence/pyams_sequence.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_sequence/pyams_sequence.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,62 @@ +.. _pyams_sequence: + +\ :mod:`pyams_sequence` package +=============================== + +.. automodule:: pyams_sequence + :members: + :undoc-members: + :show-inheritance: + +pyams_sequence.\ ``include`` +---------------------------- + +.. automodule:: pyams_sequence.include + :members: + :undoc-members: + :show-inheritance: + +pyams_sequence.\ ``schema`` +--------------------------- + +.. automodule:: pyams_sequence.schema + :members: + :undoc-members: + :show-inheritance: + +pyams_sequence.\ ``sequence`` +----------------------------- + +.. automodule:: pyams_sequence.sequence + :members: + :undoc-members: + :show-inheritance: + +pyams_sequence.\ ``site`` +------------------------- + +.. automodule:: pyams_sequence.site + :members: + :undoc-members: + :show-inheritance: + +pyams_sequence.\ ``utility`` +---------------------------- + +.. automodule:: pyams_sequence.utility + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_sequence.interfaces + pyams_sequence.rpc + pyams_sequence.tests + pyams_sequence.widget + pyams_sequence.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_sequence/pyams_sequence.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_sequence/pyams_sequence.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_sequence.tests: + +\ :mod:`pyams_sequence.tests` package +===================================== + +.. automodule:: pyams_sequence.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_sequence.tests.\ ``test_utilsdocs`` +----------------------------------------- + +.. automodule:: pyams_sequence.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_sequence.tests.\ ``test_utilsdocstrings`` +----------------------------------------------- + +.. automodule:: pyams_sequence.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_sequence/pyams_sequence.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_sequence/pyams_sequence.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_sequence.widget: + +\ :mod:`pyams_sequence.widget` package +====================================== + +.. automodule:: pyams_sequence.widget + :members: + :undoc-members: + :show-inheritance: + +pyams_sequence.widget.\ ``interfaces`` +-------------------------------------- + +.. automodule:: pyams_sequence.widget.interfaces + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_sequence/pyams_sequence.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_sequence/pyams_sequence.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_sequence.zmi: + +\ :mod:`pyams_sequence.zmi` package +=================================== + +.. automodule:: pyams_sequence.zmi + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,67 @@ +.. _pyams_skin.interfaces: + +\ :mod:`pyams_skin.interfaces` package +====================================== + +.. automodule:: pyams_skin.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.interfaces.\ ``configuration`` +----------------------------------------- + +.. automodule:: pyams_skin.interfaces.configuration + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.interfaces.\ ``container`` +------------------------------------- + +.. automodule:: pyams_skin.interfaces.container + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.interfaces.\ ``extension`` +------------------------------------- + +.. automodule:: pyams_skin.interfaces.extension + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.interfaces.\ ``metas`` +--------------------------------- + +.. automodule:: pyams_skin.interfaces.metas + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.interfaces.\ ``resources`` +------------------------------------- + +.. automodule:: pyams_skin.interfaces.resources + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.interfaces.\ ``tinymce`` +----------------------------------- + +.. automodule:: pyams_skin.interfaces.tinymce + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.interfaces.\ ``viewlet`` +----------------------------------- + +.. automodule:: pyams_skin.interfaces.viewlet + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,124 @@ +.. _pyams_skin: + +\ :mod:`pyams_skin` package +=========================== + +.. automodule:: pyams_skin + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``configuration`` +------------------------------ + +.. automodule:: pyams_skin.configuration + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``container`` +-------------------------- + +.. automodule:: pyams_skin.container + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``event`` +---------------------- + +.. automodule:: pyams_skin.event + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``extension`` +-------------------------- + +.. automodule:: pyams_skin.extension + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``help`` +--------------------- + +.. automodule:: pyams_skin.help + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``layer`` +---------------------- + +.. automodule:: pyams_skin.layer + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``metas`` +---------------------- + +.. automodule:: pyams_skin.metas + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``page`` +--------------------- + +.. automodule:: pyams_skin.page + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``resources`` +-------------------------- + +.. automodule:: pyams_skin.resources + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``site`` +--------------------- + +.. automodule:: pyams_skin.site + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``skin`` +--------------------- + +.. automodule:: pyams_skin.skin + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``table`` +---------------------- + +.. automodule:: pyams_skin.table + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.\ ``vocabulary`` +--------------------------- + +.. automodule:: pyams_skin.vocabulary + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_skin.interfaces + pyams_skin.viewlet + pyams_skin.tests + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_skin.tests: + +\ :mod:`pyams_skin.tests` package +================================= + +.. automodule:: pyams_skin.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.tests.\ ``test_utilsdocs`` +------------------------------------- + +.. automodule:: pyams_skin.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.tests.\ ``test_utilsdocstrings`` +------------------------------------------- + +.. automodule:: pyams_skin.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.activity.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.activity.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_skin.viewlet.activity: + +\ :mod:`pyams_skin.viewlet.activity` package +============================================ + +.. automodule:: pyams_skin.viewlet.activity + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.breadcrumb.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.breadcrumb.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_skin.viewlet.breadcrumb: + +\ :mod:`pyams_skin.viewlet.breadcrumb` package +============================================== + +.. automodule:: pyams_skin.viewlet.breadcrumb + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.extension.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.extension.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_skin.viewlet.extension: + +\ :mod:`pyams_skin.viewlet.extension` package +============================================= + +.. automodule:: pyams_skin.viewlet.extension + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.viewlet.extension.\ ``analytics`` +-------------------------------------------- + +.. automodule:: pyams_skin.viewlet.extension.analytics + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.viewlet.extension.\ ``tagmanager`` +--------------------------------------------- + +.. automodule:: pyams_skin.viewlet.extension.tagmanager + :members: + :undoc-members: + :show-inheritance: + +pyams_skin.viewlet.extension.\ ``user_report`` +---------------------------------------------- + +.. automodule:: pyams_skin.viewlet.extension.user_report + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.flags.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.flags.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_skin.viewlet.flags: + +\ :mod:`pyams_skin.viewlet.flags` package +========================================= + +.. automodule:: pyams_skin.viewlet.flags + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.menu.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.menu.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_skin.viewlet.menu: + +\ :mod:`pyams_skin.viewlet.menu` package +======================================== + +.. automodule:: pyams_skin.viewlet.menu + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,25 @@ +.. _pyams_skin.viewlet: + +\ :mod:`pyams_skin.viewlet` package +=================================== + +.. automodule:: pyams_skin.viewlet + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_skin.viewlet.activity + pyams_skin.viewlet.breadcrumb + pyams_skin.viewlet.extension + pyams_skin.viewlet.flags + pyams_skin.viewlet.menu + pyams_skin.viewlet.search + pyams_skin.viewlet.shortcuts + pyams_skin.viewlet.toolbar + pyams_skin.viewlet.toplinks + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.search.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.search.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_skin.viewlet.search: + +\ :mod:`pyams_skin.viewlet.search` package +========================================== + +.. automodule:: pyams_skin.viewlet.search + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.shortcuts.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.shortcuts.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_skin.viewlet.shortcuts: + +\ :mod:`pyams_skin.viewlet.shortcuts` package +============================================= + +.. automodule:: pyams_skin.viewlet.shortcuts + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.toolbar.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.toolbar.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_skin.viewlet.toolbar: + +\ :mod:`pyams_skin.viewlet.toolbar` package +=========================================== + +.. automodule:: pyams_skin.viewlet.toolbar + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_skin/pyams_skin.viewlet.toplinks.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_skin/pyams_skin.viewlet.toplinks.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_skin.viewlet.toplinks: + +\ :mod:`pyams_skin.viewlet.toplinks` package +============================================ + +.. automodule:: pyams_skin.viewlet.toplinks + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_template/pyams_template.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_template/pyams_template.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_template.interfaces: + +\ :mod:`pyams_template.interfaces` package +========================================== + +.. automodule:: pyams_template.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_template/pyams_template.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_template/pyams_template.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_template: + +\ :mod:`pyams_template` package +=============================== + +.. automodule:: pyams_template + :members: + :undoc-members: + :show-inheritance: + +pyams_template.\ ``metaconfigure`` +---------------------------------- + +.. automodule:: pyams_template.metaconfigure + :members: + :undoc-members: + :show-inheritance: + +pyams_template.\ ``metadirectives`` +----------------------------------- + +.. automodule:: pyams_template.metadirectives + :members: + :undoc-members: + :show-inheritance: + +pyams_template.\ ``template`` +----------------------------- + +.. automodule:: pyams_template.template + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_template.interfaces + pyams_template.tests + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_template/pyams_template.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_template/pyams_template.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_template.tests: + +\ :mod:`pyams_template.tests` package +===================================== + +.. automodule:: pyams_template.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_template.tests.\ ``test_utilsdocs`` +----------------------------------------- + +.. automodule:: pyams_template.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_template.tests.\ ``test_utilsdocstrings`` +----------------------------------------------- + +.. automodule:: pyams_template.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_thesaurus/pyams_thesaurus.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_thesaurus/pyams_thesaurus.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,51 @@ +.. _pyams_thesaurus.interfaces: + +\ :mod:`pyams_thesaurus.interfaces` package +=========================================== + +.. automodule:: pyams_thesaurus.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.interfaces.\ ``extension`` +------------------------------------------ + +.. automodule:: pyams_thesaurus.interfaces.extension + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.interfaces.\ ``index`` +-------------------------------------- + +.. automodule:: pyams_thesaurus.interfaces.index + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.interfaces.\ ``loader`` +--------------------------------------- + +.. automodule:: pyams_thesaurus.interfaces.loader + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.interfaces.\ ``term`` +------------------------------------- + +.. automodule:: pyams_thesaurus.interfaces.term + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.interfaces.\ ``thesaurus`` +------------------------------------------ + +.. automodule:: pyams_thesaurus.interfaces.thesaurus + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_thesaurus/pyams_thesaurus.loader.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_thesaurus/pyams_thesaurus.loader.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,35 @@ +.. _pyams_thesaurus.loader: + +\ :mod:`pyams_thesaurus.loader` package +======================================= + +.. automodule:: pyams_thesaurus.loader + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.loader.\ ``config`` +----------------------------------- + +.. automodule:: pyams_thesaurus.loader.config + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.loader.\ ``skos`` +--------------------------------- + +.. automodule:: pyams_thesaurus.loader.skos + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.loader.\ ``superdoc`` +------------------------------------- + +.. automodule:: pyams_thesaurus.loader.superdoc + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_thesaurus/pyams_thesaurus.rpc.json.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_thesaurus/pyams_thesaurus.rpc.json.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_thesaurus.rpc.json: + +\ :mod:`pyams_thesaurus.rpc.json` package +========================================= + +.. automodule:: pyams_thesaurus.rpc.json + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_thesaurus/pyams_thesaurus.rpc.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_thesaurus/pyams_thesaurus.rpc.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,17 @@ +.. _pyams_thesaurus.rpc: + +\ :mod:`pyams_thesaurus.rpc` package +==================================== + +.. automodule:: pyams_thesaurus.rpc + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_thesaurus.rpc.json + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_thesaurus/pyams_thesaurus.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_thesaurus/pyams_thesaurus.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,63 @@ +.. _pyams_thesaurus: + +\ :mod:`pyams_thesaurus` package +================================ + +.. automodule:: pyams_thesaurus + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.\ ``include`` +----------------------------- + +.. automodule:: pyams_thesaurus.include + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.\ ``index`` +--------------------------- + +.. automodule:: pyams_thesaurus.index + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.\ ``schema`` +---------------------------- + +.. automodule:: pyams_thesaurus.schema + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.\ ``term`` +-------------------------- + +.. automodule:: pyams_thesaurus.term + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.\ ``thesaurus`` +------------------------------- + +.. automodule:: pyams_thesaurus.thesaurus + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_thesaurus.interfaces + pyams_thesaurus.loader + pyams_thesaurus.rpc + pyams_thesaurus.tests + pyams_thesaurus.widget + pyams_thesaurus.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_thesaurus/pyams_thesaurus.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_thesaurus/pyams_thesaurus.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_thesaurus.tests: + +\ :mod:`pyams_thesaurus.tests` package +====================================== + +.. automodule:: pyams_thesaurus.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.tests.\ ``test_utilsdocs`` +------------------------------------------ + +.. automodule:: pyams_thesaurus.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.tests.\ ``test_utilsdocstrings`` +------------------------------------------------ + +.. automodule:: pyams_thesaurus.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_thesaurus/pyams_thesaurus.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_thesaurus/pyams_thesaurus.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_thesaurus.widget: + +\ :mod:`pyams_thesaurus.widget` package +======================================= + +.. automodule:: pyams_thesaurus.widget + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.widget.\ ``interfaces`` +--------------------------------------- + +.. automodule:: pyams_thesaurus.widget.interfaces + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_thesaurus/pyams_thesaurus.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_thesaurus/pyams_thesaurus.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,51 @@ +.. _pyams_thesaurus.zmi: + +\ :mod:`pyams_thesaurus.zmi` package +==================================== + +.. automodule:: pyams_thesaurus.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.zmi.\ ``extract`` +--------------------------------- + +.. automodule:: pyams_thesaurus.zmi.extract + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.zmi.\ ``interfaces`` +------------------------------------ + +.. automodule:: pyams_thesaurus.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.zmi.\ ``manager`` +--------------------------------- + +.. automodule:: pyams_thesaurus.zmi.manager + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.zmi.\ ``term`` +------------------------------ + +.. automodule:: pyams_thesaurus.zmi.term + :members: + :undoc-members: + :show-inheritance: + +pyams_thesaurus.zmi.\ ``thesaurus`` +----------------------------------- + +.. automodule:: pyams_thesaurus.zmi.thesaurus + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_utils/pyams_utils.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_utils/pyams_utils.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,99 @@ +.. _pyams_utils.interfaces: + +\ :mod:`pyams_utils.interfaces` package +======================================= + +.. automodule:: pyams_utils.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``data`` +--------------------------------- + +.. automodule:: pyams_utils.interfaces.data + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``inherit`` +------------------------------------ + +.. automodule:: pyams_utils.interfaces.inherit + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``intids`` +----------------------------------- + +.. automodule:: pyams_utils.interfaces.intids + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``site`` +--------------------------------- + +.. automodule:: pyams_utils.interfaces.site + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``size`` +--------------------------------- + +.. automodule:: pyams_utils.interfaces.size + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``tales`` +---------------------------------- + +.. automodule:: pyams_utils.interfaces.tales + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``text`` +--------------------------------- + +.. automodule:: pyams_utils.interfaces.text + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``timezone`` +------------------------------------- + +.. automodule:: pyams_utils.interfaces.timezone + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``traversing`` +--------------------------------------- + +.. automodule:: pyams_utils.interfaces.traversing + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``tree`` +--------------------------------- + +.. automodule:: pyams_utils.interfaces.tree + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.interfaces.\ ``zeo`` +-------------------------------- + +.. automodule:: pyams_utils.interfaces.zeo + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_utils/pyams_utils.protocol.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_utils/pyams_utils.protocol.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_utils.protocol: + +\ :mod:`pyams_utils.protocol` package +===================================== + +.. automodule:: pyams_utils.protocol + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.protocol.\ ``http`` +------------------------------- + +.. automodule:: pyams_utils.protocol.http + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.protocol.\ ``xmlrpc`` +--------------------------------- + +.. automodule:: pyams_utils.protocol.xmlrpc + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_utils/pyams_utils.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_utils/pyams_utils.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,303 @@ +.. _pyams_utils: + +\ :mod:`pyams_utils` package +============================ + +.. automodule:: pyams_utils + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``adapter`` +------------------------- + +.. automodule:: pyams_utils.adapter + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``attr`` +---------------------- + +.. automodule:: pyams_utils.attr + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``cache`` +----------------------- + +.. automodule:: pyams_utils.cache + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``container`` +--------------------------- + +.. automodule:: pyams_utils.container + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``context`` +------------------------- + +.. automodule:: pyams_utils.context + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``data`` +---------------------- + +.. automodule:: pyams_utils.data + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``date`` +---------------------- + +.. automodule:: pyams_utils.date + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``decorator`` +--------------------------- + +.. automodule:: pyams_utils.decorator + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``dict`` +---------------------- + +.. automodule:: pyams_utils.dict + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``encoding`` +-------------------------- + +.. automodule:: pyams_utils.encoding + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``factory`` +------------------------- + +.. automodule:: pyams_utils.factory + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``fanstatic`` +--------------------------- + +.. automodule:: pyams_utils.fanstatic + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``html`` +---------------------- + +.. automodule:: pyams_utils.html + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``i18n`` +---------------------- + +.. automodule:: pyams_utils.i18n + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``include`` +------------------------- + +.. automodule:: pyams_utils.include + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``inherit`` +------------------------- + +.. automodule:: pyams_utils.inherit + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``intids`` +------------------------ + +.. automodule:: pyams_utils.intids + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``list`` +---------------------- + +.. automodule:: pyams_utils.list + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``lock`` +---------------------- + +.. automodule:: pyams_utils.lock + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``progress`` +-------------------------- + +.. automodule:: pyams_utils.progress + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``property`` +-------------------------- + +.. automodule:: pyams_utils.property + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``registry`` +-------------------------- + +.. automodule:: pyams_utils.registry + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``request`` +------------------------- + +.. automodule:: pyams_utils.request + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``schema`` +------------------------ + +.. automodule:: pyams_utils.schema + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``session`` +------------------------- + +.. automodule:: pyams_utils.session + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``site`` +---------------------- + +.. automodule:: pyams_utils.site + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``size`` +---------------------- + +.. automodule:: pyams_utils.size + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``tales`` +----------------------- + +.. automodule:: pyams_utils.tales + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``text`` +---------------------- + +.. automodule:: pyams_utils.text + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``traversing`` +---------------------------- + +.. automodule:: pyams_utils.traversing + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``unicode`` +------------------------- + +.. automodule:: pyams_utils.unicode + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``url`` +--------------------- + +.. automodule:: pyams_utils.url + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``vocabulary`` +---------------------------- + +.. automodule:: pyams_utils.vocabulary + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``wsgi`` +---------------------- + +.. automodule:: pyams_utils.wsgi + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.\ ``zodb`` +---------------------- + +.. automodule:: pyams_utils.zodb + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_utils.interfaces + pyams_utils.protocol + pyams_utils.scripts + pyams_utils.tests + pyams_utils.timezone + pyams_utils.widget + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_utils/pyams_utils.scripts.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_utils/pyams_utils.scripts.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_utils.scripts: + +\ :mod:`pyams_utils.scripts` package +==================================== + +.. automodule:: pyams_utils.scripts + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.scripts.\ ``zodb`` +------------------------------ + +.. automodule:: pyams_utils.scripts.zodb + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_utils/pyams_utils.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_utils/pyams_utils.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_utils.tests: + +\ :mod:`pyams_utils.tests` package +================================== + +.. automodule:: pyams_utils.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.tests.\ ``test_utilsdocs`` +-------------------------------------- + +.. automodule:: pyams_utils.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.tests.\ ``test_utilsdocstrings`` +-------------------------------------------- + +.. automodule:: pyams_utils.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_utils/pyams_utils.timezone.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_utils/pyams_utils.timezone.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_utils.timezone: + +\ :mod:`pyams_utils.timezone` package +===================================== + +.. automodule:: pyams_utils.timezone + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.timezone.\ ``utility`` +---------------------------------- + +.. automodule:: pyams_utils.timezone.utility + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.timezone.\ ``vocabulary`` +------------------------------------- + +.. automodule:: pyams_utils.timezone.vocabulary + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_utils/pyams_utils.widget.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_utils/pyams_utils.widget.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_utils.widget: + +\ :mod:`pyams_utils.widget` package +=================================== + +.. automodule:: pyams_utils.widget + :members: + :undoc-members: + :show-inheritance: + +pyams_utils.widget.\ ``decimal`` +-------------------------------- + +.. automodule:: pyams_utils.widget.decimal + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_viewlet/pyams_viewlet.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_viewlet/pyams_viewlet.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_viewlet.interfaces: + +\ :mod:`pyams_viewlet.interfaces` package +========================================= + +.. automodule:: pyams_viewlet.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_viewlet/pyams_viewlet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_viewlet/pyams_viewlet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,59 @@ +.. _pyams_viewlet: + +\ :mod:`pyams_viewlet` package +============================== + +.. automodule:: pyams_viewlet + :members: + :undoc-members: + :show-inheritance: + +pyams_viewlet.\ ``manager`` +--------------------------- + +.. automodule:: pyams_viewlet.manager + :members: + :undoc-members: + :show-inheritance: + +pyams_viewlet.\ ``metaconfigure`` +--------------------------------- + +.. automodule:: pyams_viewlet.metaconfigure + :members: + :undoc-members: + :show-inheritance: + +pyams_viewlet.\ ``metadirectives`` +---------------------------------- + +.. automodule:: pyams_viewlet.metadirectives + :members: + :undoc-members: + :show-inheritance: + +pyams_viewlet.\ ``provider`` +---------------------------- + +.. automodule:: pyams_viewlet.provider + :members: + :undoc-members: + :show-inheritance: + +pyams_viewlet.\ ``viewlet`` +--------------------------- + +.. automodule:: pyams_viewlet.viewlet + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_viewlet.interfaces + pyams_viewlet.tests + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_viewlet/pyams_viewlet.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_viewlet/pyams_viewlet.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_viewlet.tests: + +\ :mod:`pyams_viewlet.tests` package +==================================== + +.. automodule:: pyams_viewlet.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_viewlet.tests.\ ``test_utilsdocs`` +---------------------------------------- + +.. automodule:: pyams_viewlet.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_viewlet.tests.\ ``test_utilsdocstrings`` +---------------------------------------------- + +.. automodule:: pyams_viewlet.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_workflow/pyams_workflow.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_workflow/pyams_workflow.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_workflow.interfaces: + +\ :mod:`pyams_workflow.interfaces` package +========================================== + +.. automodule:: pyams_workflow.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_workflow/pyams_workflow.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_workflow/pyams_workflow.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,52 @@ +.. _pyams_workflow: + +\ :mod:`pyams_workflow` package +=============================== + +.. automodule:: pyams_workflow + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.\ ``content`` +---------------------------- + +.. automodule:: pyams_workflow.content + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.\ ``include`` +---------------------------- + +.. automodule:: pyams_workflow.include + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.\ ``versions`` +----------------------------- + +.. automodule:: pyams_workflow.versions + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.\ ``workflow`` +----------------------------- + +.. automodule:: pyams_workflow.workflow + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_workflow.interfaces + pyams_workflow.tests + pyams_workflow.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_workflow/pyams_workflow.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_workflow/pyams_workflow.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_workflow.tests: + +\ :mod:`pyams_workflow.tests` package +===================================== + +.. automodule:: pyams_workflow.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.tests.\ ``test_utilsdocs`` +----------------------------------------- + +.. automodule:: pyams_workflow.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.tests.\ ``test_utilsdocstrings`` +----------------------------------------------- + +.. automodule:: pyams_workflow.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_workflow/pyams_workflow.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_workflow/pyams_workflow.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,42 @@ +.. _pyams_workflow.zmi: + +\ :mod:`pyams_workflow.zmi` package +=================================== + +.. automodule:: pyams_workflow.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.zmi.\ ``interfaces`` +----------------------------------- + +.. automodule:: pyams_workflow.zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.zmi.\ ``transition`` +----------------------------------- + +.. automodule:: pyams_workflow.zmi.transition + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.zmi.\ ``versions`` +--------------------------------- + +.. automodule:: pyams_workflow.zmi.versions + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_workflow.zmi.viewlet + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_workflow/pyams_workflow.zmi.viewlet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_workflow/pyams_workflow.zmi.viewlet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_workflow.zmi.viewlet: + +\ :mod:`pyams_workflow.zmi.viewlet` package +=========================================== + +.. automodule:: pyams_workflow.zmi.viewlet + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.zmi.viewlet.\ ``transitions`` +-------------------------------------------- + +.. automodule:: pyams_workflow.zmi.viewlet.transitions + :members: + :undoc-members: + :show-inheritance: + +pyams_workflow.zmi.viewlet.\ ``versions`` +----------------------------------------- + +.. automodule:: pyams_workflow.zmi.viewlet.versions + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zmi/pyams_zmi.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zmi/pyams_zmi.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_zmi.interfaces: + +\ :mod:`pyams_zmi.interfaces` package +===================================== + +.. automodule:: pyams_zmi.interfaces + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.interfaces.\ ``menu`` +------------------------------- + +.. automodule:: pyams_zmi.interfaces.menu + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zmi/pyams_zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zmi/pyams_zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,61 @@ +.. _pyams_zmi: + +\ :mod:`pyams_zmi` package +========================== + +.. automodule:: pyams_zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.\ ``configuration`` +----------------------------- + +.. automodule:: pyams_zmi.configuration + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.\ ``form`` +-------------------- + +.. automodule:: pyams_zmi.form + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.\ ``layer`` +--------------------- + +.. automodule:: pyams_zmi.layer + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.\ ``skin`` +-------------------- + +.. automodule:: pyams_zmi.skin + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.\ ``view`` +-------------------- + +.. automodule:: pyams_zmi.view + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_zmi.interfaces + pyams_zmi.tests + pyams_zmi.viewlet + pyams_zmi.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zmi/pyams_zmi.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zmi/pyams_zmi.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_zmi.tests: + +\ :mod:`pyams_zmi.tests` package +================================ + +.. automodule:: pyams_zmi.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.tests.\ ``test_utilsdocs`` +------------------------------------ + +.. automodule:: pyams_zmi.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.tests.\ ``test_utilsdocstrings`` +------------------------------------------ + +.. automodule:: pyams_zmi.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zmi/pyams_zmi.viewlet.menu.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zmi/pyams_zmi.viewlet.menu.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_zmi.viewlet.menu: + +\ :mod:`pyams_zmi.viewlet.menu` package +======================================= + +.. automodule:: pyams_zmi.viewlet.menu + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zmi/pyams_zmi.viewlet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zmi/pyams_zmi.viewlet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,17 @@ +.. _pyams_zmi.viewlet: + +\ :mod:`pyams_zmi.viewlet` package +================================== + +.. automodule:: pyams_zmi.viewlet + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + pyams_zmi.viewlet.menu + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zmi/pyams_zmi.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zmi/pyams_zmi.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,83 @@ +.. _pyams_zmi.zmi: + +\ :mod:`pyams_zmi.zmi` package +============================== + +.. automodule:: pyams_zmi.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.zmi.\ ``control_panel`` +--------------------------------- + +.. automodule:: pyams_zmi.zmi.control_panel + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.zmi.\ ``extension`` +----------------------------- + +.. automodule:: pyams_zmi.zmi.extension + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.zmi.\ ``index`` +------------------------- + +.. automodule:: pyams_zmi.zmi.index + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.zmi.\ ``intids`` +-------------------------- + +.. automodule:: pyams_zmi.zmi.intids + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.zmi.\ ``site`` +------------------------ + +.. automodule:: pyams_zmi.zmi.site + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.zmi.\ ``skin`` +------------------------ + +.. automodule:: pyams_zmi.zmi.skin + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.zmi.\ ``table`` +------------------------- + +.. automodule:: pyams_zmi.zmi.table + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.zmi.\ ``timezone`` +---------------------------- + +.. automodule:: pyams_zmi.zmi.timezone + :members: + :undoc-members: + :show-inheritance: + +pyams_zmi.zmi.\ ``zeo`` +----------------------- + +.. automodule:: pyams_zmi.zmi.zeo + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zmq/pyams_zmq.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zmq/pyams_zmq.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_zmq.interfaces: + +\ :mod:`pyams_zmq.interfaces` package +===================================== + +.. automodule:: pyams_zmq.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zmq/pyams_zmq.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zmq/pyams_zmq.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,43 @@ +.. _pyams_zmq: + +\ :mod:`pyams_zmq` package +========================== + +.. automodule:: pyams_zmq + :members: + :undoc-members: + :show-inheritance: + +pyams_zmq.\ ``handler`` +----------------------- + +.. automodule:: pyams_zmq.handler + :members: + :undoc-members: + :show-inheritance: + +pyams_zmq.\ ``process`` +----------------------- + +.. automodule:: pyams_zmq.process + :members: + :undoc-members: + :show-inheritance: + +pyams_zmq.\ ``socket`` +---------------------- + +.. automodule:: pyams_zmq.socket + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_zmq.interfaces + pyams_zmq.tests + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zmq/pyams_zmq.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zmq/pyams_zmq.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_zmq.tests: + +\ :mod:`pyams_zmq.tests` package +================================ + +.. automodule:: pyams_zmq.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_zmq.tests.\ ``test_utilsdocs`` +------------------------------------ + +.. automodule:: pyams_zmq.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_zmq.tests.\ ``test_utilsdocstrings`` +------------------------------------------ + +.. automodule:: pyams_zmq.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zodbbrowser/pyams_zodbbrowser.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zodbbrowser/pyams_zodbbrowser.interfaces.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _pyams_zodbbrowser.interfaces: + +\ :mod:`pyams_zodbbrowser.interfaces` package +============================================= + +.. automodule:: pyams_zodbbrowser.interfaces + :members: + :undoc-members: + :show-inheritance: + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zodbbrowser/pyams_zodbbrowser.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zodbbrowser/pyams_zodbbrowser.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,68 @@ +.. _pyams_zodbbrowser: + +\ :mod:`pyams_zodbbrowser` package +================================== + +.. automodule:: pyams_zodbbrowser + :members: + :undoc-members: + :show-inheritance: + +pyams_zodbbrowser.\ ``btreesupport`` +------------------------------------ + +.. automodule:: pyams_zodbbrowser.btreesupport + :members: + :undoc-members: + :show-inheritance: + +pyams_zodbbrowser.\ ``cache`` +----------------------------- + +.. automodule:: pyams_zodbbrowser.cache + :members: + :undoc-members: + :show-inheritance: + +pyams_zodbbrowser.\ ``diff`` +---------------------------- + +.. automodule:: pyams_zodbbrowser.diff + :members: + :undoc-members: + :show-inheritance: + +pyams_zodbbrowser.\ ``history`` +------------------------------- + +.. automodule:: pyams_zodbbrowser.history + :members: + :undoc-members: + :show-inheritance: + +pyams_zodbbrowser.\ ``state`` +----------------------------- + +.. automodule:: pyams_zodbbrowser.state + :members: + :undoc-members: + :show-inheritance: + +pyams_zodbbrowser.\ ``value`` +----------------------------- + +.. automodule:: pyams_zodbbrowser.value + :members: + :undoc-members: + :show-inheritance: + + +Subpackages +----------- + +.. toctree:: + + pyams_zodbbrowser.interfaces + pyams_zodbbrowser.tests + pyams_zodbbrowser.zmi + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zodbbrowser/pyams_zodbbrowser.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zodbbrowser/pyams_zodbbrowser.tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,27 @@ +.. _pyams_zodbbrowser.tests: + +\ :mod:`pyams_zodbbrowser.tests` package +======================================== + +.. automodule:: pyams_zodbbrowser.tests + :members: + :undoc-members: + :show-inheritance: + +pyams_zodbbrowser.tests.\ ``test_utilsdocs`` +-------------------------------------------- + +.. automodule:: pyams_zodbbrowser.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams_zodbbrowser.tests.\ ``test_utilsdocstrings`` +-------------------------------------------------- + +.. automodule:: pyams_zodbbrowser.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/api-doc/pyams_zodbbrowser/pyams_zodbbrowser.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/api-doc/pyams_zodbbrowser/pyams_zodbbrowser.zmi.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _pyams_zodbbrowser.zmi: + +\ :mod:`pyams_zodbbrowser.zmi` package +====================================== + +.. automodule:: pyams_zodbbrowser.zmi + :members: + :undoc-members: + :show-inheritance: + +pyams_zodbbrowser.zmi.\ ``views`` +--------------------------------- + +.. automodule:: pyams_zodbbrowser.zmi.views + :members: + :undoc-members: + :show-inheritance: + + diff -r 000000000000 -r b2be9a32f3fc src/source/app.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/app.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,10 @@ +.. _app: + +Configuring and Running PyAMS +============================= + +.. toctree:: + :maxdepth: 2 + + appconfig + appstart diff -r 000000000000 -r b2be9a32f3fc src/source/appconfig.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/appconfig.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,80 @@ +.. _config: + +PyAMS configuration +=================== + +.. Note:: + + PyAMS application configuration is done via several complementary ways: + + - via **Pyramid's configuration** files located in 'etc/' folder + + - via **ZCML files** . + + - via **Site Management** to setup Local utilities defined into ZODB (see :ref:`appmanage`) + + +Pyramid's configuration files +----------------------------- + +PyAMS is using default Pyramid's ini_ configuration files to define settings. When using default PyAMS scaffold, these +INI files are stored into *etc* folder. Two files are created by scaffold: a development file (*development.ini*) and +a production file (*production.ini*) which contain nearly the same directives, except for debug toolbar (activated only +in development), Fanstatic configuration and logging. + +.. _ini: https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/project.html#development-ini + +These files are actually documented, but here are a few important directives: + +- **zodbconn.uri**: (ex: zconfig:/zodb-relstorage.conf) + +- **pyams.application_name**: Name of your own application +- **pyams.application_factory**: Configuration module path to your custom application. + +- **pyams_xxx.tcp_handler** : Adress of the tcp handler for the service associated to the pyams package +- **pyams_xxx.start_handler**: True / False + +- **pyams_content.config.xxx_tool_factory** and **pyams_content.config.xxx_tool_name**: You can override default factory by defining these settings or by providing your own adapters. + + + +Pyramid's configuration files powered by PyAMS_utils +---------------------------------------------------- + +On application startup, if PyAMS_utils package is included into Pyramid configuration, several operations take +place: + + - a custom **site factory** is defined + + - custom request methods are defined + + - a custom **traverser** handling **namespaces** is defined + + - a custom subscribers predicate based on interfaces support is defined + + - several adapters are registered, to handle annotations and key references + + - custom TALES extensions are registered. + +The site factory is an important component in this process. It is this factory which will define the application root +and create a **local site manager**. + +Pyramid application is loaded from ZODB's root via a key defined in Pyramid's configuration file; the key is named +*pyams.application_name* and it's default value is *application*. + +If the application can't be found, PyAMS is looking for an application class name in Pyramid's configuration file; the +class name configuration key is called *pyams.application_factory* and defined by default as +*pyams_utils.site.BaseSiteRoot*. PyAMS default site factory will then create the application, and add a local site +manager to it (see :ref:`zca`). + +After application creation, a :py:class:`NewLocalSiteCreatedEvent ` is +notified. Custom packages can subscribe to this event to register custom components. + + + +ZCML configuration files +------------------------ + +Adding more ZCML configuration directives is not mandatory in any way but can be useful in several use cases. For +example, templates can't be overriden via Python annotations without creating a new subclass; this can be done +easily via ZCML. diff -r 000000000000 -r b2be9a32f3fc src/source/appextend.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/appextend.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,18 @@ +.. _appextend: + + +How to extend PyAMS ? +===================== + +.. toctree:: + :maxdepth: 1 + + + howto-adapter + howto-form + howto-paragraph + howto-portlet + howto-renderer + howto-rename + howto-skin + howto-template diff -r 000000000000 -r b2be9a32f3fc src/source/appinstall.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/appinstall.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,244 @@ +.. _appinstall: + +.. _install: + +Installing PyAMS application +============================ + +**PyAMS** default installation is based on `Buildout `_ utility. + +.. tip:: + + Take a look at virtualenv_. This tool provide isolated Python environments, which are more practical than installing packages systemwide. + They also allow installing packages without administrator privileges. + +.. _virtualenv: https://virtualenv.pypa.io/en/stable/ + + +Current PyAMS version is based and validated for **Python 3.5**; your Python environment must also include a **C compiler** +as well as development headers for Python, *libjpeg*, *libpng*, *libfreetype*, *libxml2*, *libxslt* and +eventually *libldap*, *libpq*, *libffi*, *libgdal* or *libzmq*. **Cython** compiler can also be useful to optimize +several packages. + + +.. note:: + + PyAMS default components configuration also pre-suppose that the following external services are available. + + * Mandatory services: + + - a **ZODB shared server** (see :ref:`zodb` before). Several background processes needing a concurrent access to ZODB are started by PyAMS main process. Three ZODB storages are already provided through PyAMS: ZEO, RelStorage or Newt.db. + + - a **Memcached** or **Redis*** server, to store sessions and cache + + * Optional services: + + - an **LDAP server** for authentication + + - an **ElasticSearch server** for full text indexing (see *PyAMS_content_es* package) + + - a **WebSockets server** using AsyncIO. This is used to manage notifications (see *PyAMS_notify* and *PyAMS_notify_ws* packages). An *out of the box* environment can be built using *pyams_notify* scaffold. + + +Creating initial buildout +------------------------- + +PyAMS provides a new Pyramid scaffold, called *pyams*, generated via a *cookiecutter* template. + +A simple option to install PyAMS is to create a buildout environment including *Pyramid* and all *PyAMS* packages: + +.. code-block:: bash + + $ mkdir /var/local/ + $ pip3 install virtualenv + $ virtualenv --python=python3.5 env + $ cd env + $ . bin/activate + (env) $ pip3.5 install cookiecutter + (env) $ cookiecutter hg+http://hg.ztfy.org/pyams/scaffolds/pyams + +*CookieCutter* will ask you for a small set of input variables that you can change or not (**parameter** [*default value*]:) + +- **pyams_release** [*latest*] : version of PyAMS configuration file to use. "latest" will point to last release; + you can also choose to point to a given release ("0.1.4" for example) + +- **project_name** [*PyAMS*]: current environment name in "human form" + +- **project_slug**: [*pyams*] "technical" package name, based on project name + +- **virtual_hostname** [*pyams.mydomain.com*]: Apache virtual-host name + +- **webapp_name** [*webapps*]: web application package name + +- **webapp_port** [*6543*]: TCP/IP port to use when running application outside Apache. + +- **eggs_directory** [*eggs*]: relative or absolute path to directory containing downloaded eggs; this directory can be + shared with other projects. + +- **logs_directory** [*/var/log*]: absolute path to directory containing Apache's log files + +- **run_user** [*www-data*]: user name under which Apache process will run + +- **run_group** [*www-data*]: group name under which Apache process will run + +- **beaker_backend** : name of Beaker backend to use to store sessions and cache data ("redis" as default) + +- **beaker_server** [*127.0.0.1:6379*]: IP address and port of Beaker backend server + +- **db_type** [*zeo*]: ZODB database storage; available options include ZEO, RelStorage and NewtDB + +- **db_host** [*127.0.0.1*]: IP address of database server ("127.0.0.1" as default); WARNING: database server installation + is not part of application installation; another "zeo_server" cookiecutter recipe is available for ZEO + +- **db_port** [*8100*]: listening port of database server ("8100" is given as default for ZEO) + +- **db_name** [*pyams*]: database or ZEO storage name to use + +- **db_username**: database user name + +- **db_password**: database password + +- **zeo_realm**: ZEO authentication realm + +- **blobs_dir** [*/var/db/blobs*]: local directory to use to store cache of ZODB blobs; cache size is limited to 10GB as default + +- **use_postgresql**: specify if PostgreSQL access is required; if so, please check that PostgreSQL development files + are available to compile PsycoPG2 extension + +- **use_oracle**: specify if Oracle access is required; if so, please check that Oracle development files are + available to compile cx_Oracle extension, and that ORACLE_HOME environment variable is correctly defined (see below) + +- **use_ldap**: specify if LDAP access will be required for authentication + +- **use_elasticsearch**: specify if an ElasticSearch server will be used for indexation + +- **elasticsearch_server**: URL used to access Elasticsearch server ("http://127.0.0.1:9200" as default); this URL can + include login and password ("http://login:password@127.0.0.1:9200"), if required... + +- **elasticsearch_index**: name of Elasticsearch index to use ("pyams" as default) + +- **create_elasticsearch_index**: specify if Elasticsearch index should be created after installation is complete + +- **define_elasticsearch_mappings** : specify if Elasticsearch mappings should be defined after installation is complete + +- **smtp_server**: DNS name of SMTP server ("localhost" as default) + +- **smtp_server_name**: "human" name given to SMTP server ("pyams" as default) + +- **pyams_scheduler** [*127.0.0.1:5555*]: TCP/IP address and port to use to access PyAMS tasks scheduler process (see :ref:`pyams_scheduler`) + +- **start_scheduler** [*True*]: boolean value to indicate if scheduler process is started by this application instance + +- **pyams_medias_converter** [*127.0.0.1:5556*]: TCP/IP address and port to use to access PyAMS medias converter process (see :ref:`pyams_media`) + +- **start_medias_converter** [*True*]: boolean value to indicate if medias converter process is started by this application + instance + +- **pyams_es_indexer** [*127.0.0.1:5557*] : TCP/IP address and port to use to access PyAMS Elasticsearch indexer process (see :ref:`pyams_content_es`) + +- **start_es_indexer** boolean value to indicate if Elasticsearch indexer process is started by this application + instance + +- **use_notifications**: specify if PyAMS notifications services are to be used (see :ref:`pyams_notify`) + +- **pyams_ws_notify** [*127.0.0.1:8081*]: TCP/IP address and port of PyAMS websockets server managing notifications service + +- **lexicon_languages**: NLTK lexicon languages to use ("en:english fr:french" as default) + +- **extension_package**: name of a PyAMS extension package to include in environment configuration + +- **need_pyams_gis**: specify if PyAMS GIS features are to be used by given extension package; if so, please check + that *libgdal* development files are available; on Debian (and maybe others), you have to specify environment + variables (see below). + +.. tip:: + + 1. Setting any option to empty string will keep the default proposed value. + 2. Boolean values accept "true", "yes", "on" or "1" (in any case) as *true* values, and anything else as *false*; + +You can then check, and eventually update, the proposed Buildout configuration file *buildout.cfg*, to add or remove +packages or update settings to your needs. + +This last operation can be quite long, as many packages have to downloaded, compiled and installed in the virtual +environment. If you encounter any compile error, just install the required dependencies and restart the buildout. + +Some dependencies can require the definition of custom environment variables before running *buildout*, like: + +- for *libgdal*, which is required by **PyAMS_gis** package, use: + +.. code-block:: bash + + (env) $ export C_INCLUDE_PATH=/usr/include/gdal + (env) $ export CPLUS_INCLUDE_PATH=/usr/include/gdal + + +.. WARNING:: + You have to check also that your *libgdal* release is matching "GDAL" release given in PyAMS + configuration file (actually 2.1.0). + +- for *cx_Oracle*, which is required if you use Oracle database connections, use: + +.. code-block:: bash + + (env) $ export ORACLE_HOME=/usr/lib/oracle/12.1/client64 + +These examples are given for Debian GNU/Linux. You may have to adapt configuration based on your own Linux +distribution and packages versions. + + +**Then finalize Bootstrap initialization:** + +.. code-block:: bash + + (env) $ python3.5 bootstrap.py + (env) $ ./bin/buildout + + +.. seealso:: + + `zc.buildout `_ is a powerful + tool for creating repeatable builds of a given software configuration + and environment. + + +Environment settings +-------------------- + +The project generated from *pyams* scaffold is based on default Pyramid's *zodb* scaffold, but it adds: + +- a custom application factory, in the *webapp* directory (see :ref:`site`) + +- a set of directories to store runtime data, in the *var* directory; each directory contains a *README.txt* file + which should be self-explanatory to indicate what this directory should contain, including a ZEO cache + +- a set of configuration files, in the *etc* directory; here are standard *development.ini* and *production.ini* + configuration files, a ZODB configuration files (*zodb-zeo.conf*) for a ZEO client storage and two Apache + configurations (for Apache 2.2 and 2.4) using *mod_wsgi*. + +Once the project have been created from the scaffold, you are free to update all the configuration files. + +If you need to add packages to the environment, you have to add them to the *buildout.cfg* file **AND** to the INI +file (in the *pyramid.includes* section) before running the *buildout* another time; don't forget to add the +requested version at the end of *buildout.cfg* file, as Buildout is not configured by default to automatically +download the last release of a given unknown package. + +*development.ini* and *production.ini* files contain many commented directives related to PyAMS components. Read and +update them carefully before initializing your application database! + + +.. _zodbinit: + +Initializing the ZODB database +------------------------------ + +After, you have downloaded and installed all required packages, you have to initialize the database so that all +required components are available. + +From a shell, just type: + +.. code-block:: bash + + (env) $ ./bin/pyams_upgrade etc/development.ini + +This process requires that every package is correctly included into *pyramid.includes* directive from selected +configuration file. diff -r 000000000000 -r b2be9a32f3fc src/source/appmanage.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/appmanage.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,79 @@ +.. _appmanage: + +.. _site: + + +PyAMS admin site +================ + +PyAMS admin site (called also **ZMI**, in memory of old **\Z**\ope **\M**\anagement **\I**\nterface) is based on the ZODB. + +When the PyAMS is initialized, it create and register several utilities into the *local registry* and saved into ZODB. +These utilities are created with default values which can be modified through **management interface** when +the application is started by default (http://localhost:6543/admin). + + +Local registry utilities +'''''''''''''''''''''''' + +One of PyAMS pre-requisites is to use the ZODB, at least to store the site root application, +it's configuration and a set of local utilities. + +Some important utilities include: + +**Catalog**: + The catalog has the responsibility to index every content properties which are required to make quick + and efficient searches. Catalog indexes are automatically created on database upgrade; management interface + allows administrator to get indexes properties, to get the number of indexed objects and values for a given index, and + to delete an index before recreating it by running the database upgrade script another time (see :ref:`scripts`). + +**Internal IDs** utility: + The catalog object doesn't store direct references to objects, but their internal IDs which are generated by this + utility. + +**Language negotiator**: + As a web site or application can be localized, this utility allows you to define priorities between language + definition options (between *user session*, *browser* end *server*), and to define which languages are available + to your users (which is particularly important when managing potentially multi-lingual contents). + + .. tip:: + Static texts like those displayed into PyAMS management interface are always translated to the language defined + into browser language, if available. + +**Portal templates** container: + Portal templates are used to define *presentation templates* based on *portlets* (see :ref:`pyams_portal`). You can + create *local* templates, or create *shared templates* into this utility which can then be reused into several + places in your web site. + +**Security manager**: + This utility is used to define authentication sources which will be available to authenticate your users. + :ref:`pyams_security` package provides several authentication modules (like local users, or via OAuth/OAuth2 + providers); :ref:`pyams_ldap` add authentication plug-in via an LDAP directory. + +**Sequential IDs** utility: + This utility is used to assign simple sequential IDs to site contents (like sites, news, topics and more); these + IDs are simple to identify a given content; several versions of a given content handle by workflow share the same + sequential ID. + +**Server timezone** utility: + Define the timezone server to display date and time accordingly. + +**User profiles** container: + This utility is used to store information associated to principals through their user profile. + + +Optional utilities can also include: + +**Elasticearch content indexer**: + +Verifier la connection entre le server ElasticSearch et la l'application PyAMS + +**Maps manager**: +Systeme de cartografie, avec OpenStreeMaps, WMS, GeoPortable, ESRI ou encore Google Maps +permet de créer des zones catographique² + +**Medias converter**: + + +**Tasks scheduler**: + diff -r 000000000000 -r b2be9a32f3fc src/source/appstart.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/appstart.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,95 @@ +.. _appstart: + +Starting the application +======================== + +When database upgrade process has ended ( :ref:`zodbinit` ) , you can start the web application process with the standard Pyramid's +*pserve* command line tool: + +.. code-block:: bash + + (env) $ ./bin/pserve etc/development.ini + +In standard debug mode, all registered components are displayed in the console, until the final line (here using ZEO): + +.. code-block:: bash + + 2018-01-14 11:37:54,339 INFO [ZEO.ClientStorage][MainThread] [('127.0.0.1', 8100)] ClientStorage (pid=28695) created RW/normal for storage: 'pyams' + 2018-01-14 11:37:54,340 INFO [ZEO.cache][MainThread] created temporary cache file 3 + 2018-01-14 11:37:54,345 INFO [ZODB.blob][MainThread] (28695) Blob directory `/var/local/env/pyams/var/db/blobs` is used but has no layout marker set. Selected `lawn` layout. + 2018-01-14 11:37:54,345 WARNI [ZODB.blob][MainThread] (28695) The `lawn` blob directory layout is deprecated due to scalability issues on some file systems, please consider migrating to the `bushy` layout. + 2018-01-14 11:37:54,346 DEBUG [asyncio][[('127.0.0.1', 8100)] zeo client networking thread] Using selector: EpollSelector + 2018-01-14 11:37:54,347 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] disconnected None + 2018-01-14 11:37:54,348 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] try_connecting + 2018-01-14 11:37:54,349 INFO [ZEO.asyncio.base][[('127.0.0.1', 8100)] zeo client networking thread] Connected Protocol(('127.0.0.1', 8100), 'pyams', False) + 2018-01-14 11:37:54,355 INFO [ZEO.ClientStorage][[('127.0.0.1', 8100)] zeo client networking thread] [('127.0.0.1', 8100)] Connected to storage: ('localhost', 8100) + 2018-01-14 11:37:54,358 DEBUG [txn.140663320073984][MainThread] new transaction + 2018-01-14 11:37:54,360 DEBUG [txn.140663320073984][MainThread] commit + 2018-01-14 11:37:54,484 DEBUG [config][MainThread] include /home/tflorac/Dropbox/src/PyAMS/pyams_template/src/pyams_template/configure.zcml + 2018-01-14 11:37:54,485 DEBUG [config][MainThread] include /var/local/env/pycharm/lib/python3.5/site-packages/pyramid_zcml/configure.zcml + ... + 2018-01-14 11:37:54,833 DEBUG [PyAMS (utils)][MainThread] Registering utility named 'PyAMS timezone' providing + 2018-01-14 11:37:54,834 DEBUG [PyAMS (utils)][MainThread] Registering class as vocabulary with name "PyAMS timezones" + 2018-01-14 11:37:54,835 DEBUG [PyAMS (utils)][MainThread] Registering adapter for (,) providing + 2018-01-14 11:37:54,839 DEBUG [PyAMS (utils)][MainThread] Registering adapter for (, , ) providing + 2018-01-14 11:37:54,847 DEBUG [PyAMS (utils)][MainThread] Registering adapter for (, ) providing + 2018-01-14 11:37:54,942 DEBUG [PyAMS (utils)][MainThread] Registering adapter for (,) providing + 2018-01-14 11:37:54,943 DEBUG [PyAMS (pagelet)][MainThread] Registering pagelet view "properties.html" for () + 2018-01-14 11:37:54,949 DEBUG [PyAMS (pagelet)][MainThread] Registering pagelet view "properties.html" for () + 2018-01-14 11:37:54,980 DEBUG [PyAMS (utils)][MainThread] Registering class as vocabulary with name "PyAMS ZEO connections" + 2018-01-14 11:37:54,981 DEBUG [PyAMS (utils)][MainThread] Registering class as vocabulary with name "PyAMS ZODB connections" + 2018-01-14 11:37:55,015 DEBUG [PyAMS (pagelet)][MainThread] Registering pagelet view "add-zeo-connection.html" for () + 2018-01-14 11:37:55,016 DEBUG [PyAMS (utils)][MainThread] Registering adapter for (, ) providing + 2018-01-14 11:37:55,017 DEBUG [PyAMS (pagelet)][MainThread] Registering pagelet view "properties.html" for () + ... + 2018-01-14 11:41:13,214 DEBUG [PyAMS (utils)][MainThread] Registering adapter for (, , ) providing + 2018-01-14 11:43:36,665 INFO [ZEO.ClientStorage][MainThread] [('127.0.0.1', 8100)] ClientStorage (pid=29335) created RW/normal for storage: 'pyams' + 2018-01-14 11:43:36,665 INFO [ZEO.cache][MainThread] created temporary cache file 9 + 2018-01-14 11:43:36,673 DEBUG [asyncio][[('127.0.0.1', 8100)] zeo client networking thread] Using selector: EpollSelector + 2018-01-14 11:43:36,674 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328 Checking blob cache size. (target: 966367642) + 2018-01-14 11:43:36,674 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] disconnected None + 2018-01-14 11:43:36,675 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328 blob cache size: 0 + 2018-01-14 11:43:36,675 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] try_connecting + 2018-01-14 11:43:36,675 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328 --> + 2018-01-14 11:43:36,677 INFO [ZEO.asyncio.base][[('127.0.0.1', 8100)] zeo client networking thread] Connected Protocol(('127.0.0.1', 8100), 'pyams', False) + 2018-01-14 11:43:36,679 INFO [ZEO.ClientStorage][[('127.0.0.1', 8100)] zeo client networking thread] [('127.0.0.1', 8100)] Connected to storage: ('localhost', 8100) + 2018-01-14 11:43:36,682 DEBUG [txn.140713340237568][MainThread] new transaction + 2018-01-14 11:43:36,683 DEBUG [txn.140713340237568][MainThread] commit + 2018-01-14 11:43:36,690 INFO [PyAMS (scheduler][MainThread] Starting tasks scheduler ... + 2018-01-14 11:43:36,698 INFO [PyAMS (scheduler][MainThread] Started tasks scheduler with PID 29361. + 2018-01-14 11:43:36,701 INFO [apscheduler.scheduler][MainThread] Scheduler started + 2018-01-14 11:43:36,702 DEBUG [apscheduler.scheduler][APScheduler] Looking for jobs to run + 2018-01-14 11:43:36,704 DEBUG [apscheduler.scheduler][APScheduler] No jobs; waiting until a job is added + 2018-01-14 11:43:36,719 INFO [ZEO.ClientStorage][MainThread] [('127.0.0.1', 8100)] ClientStorage (pid=29335) created RW/normal for storage: 'pyams' + 2018-01-14 11:43:36,720 INFO [ZEO.cache][MainThread] created temporary cache file 15 + 2018-01-14 11:43:36,724 DEBUG [asyncio][[('127.0.0.1', 8100)] zeo client networking thread] Using selector: EpollSelector + 2018-01-14 11:43:36,725 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] disconnected None + 2018-01-14 11:43:36,726 DEBUG [ZEO.asyncio.client][[('127.0.0.1', 8100)] zeo client networking thread] try_connecting + 2018-01-14 11:43:36,727 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328 Checking blob cache size. (target: 966367642) + 2018-01-14 11:43:36,728 INFO [ZEO.asyncio.base][[('127.0.0.1', 8100)] zeo client networking thread] Connected Protocol(('127.0.0.1', 8100), 'pyams', False) + 2018-01-14 11:43:36,729 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328 blob cache size: 0 + 2018-01-14 11:43:36,729 DEBUG [ZEO.ClientStorage.check_blob_cache][[('127.0.0.1', 8100)] zeo client check blob size thread] 140712483907328 --> + 2018-01-14 11:43:36,732 INFO [ZEO.ClientStorage][[('127.0.0.1', 8100)] zeo client networking thread] [('127.0.0.1', 8100)] Connected to storage: ('localhost', 8100) + 2018-01-14 11:43:36,735 DEBUG [txn.140713340237568][MainThread] new transaction + 2018-01-14 11:43:36,736 DEBUG [txn.140713340237568][MainThread] commit + 2018-01-14 11:43:36,743 INFO [PyAMS (media)][MainThread] Starting medias converter ... + 2018-01-14 11:43:36,751 INFO [PyAMS (media)][MainThread] Started medias converter with PID 29367. + Starting server in PID 29335. + Serving on http://0.0.0.0:6543 + + +Congrats: PyAMS is running ! + +Launch a browser and open URL http://127.0.0.1:6543/admin to get access to PyAMS management interface. + +.. warning:: + + By default: + + - Login: admin + + - Password: admin + + **You must change it as soon as possible!** + (see :ref:`pyams_security`)!!. + diff -r 000000000000 -r b2be9a32f3fc src/source/architecture.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/architecture.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,47 @@ +.. _architecture: + +PyAMS application architecture +============================== + +PyAMS applications are built on a small set of prerequisites and external components which *can* or, for some of them, +*must* be included, the minimal configuration is: + +* a mandatory shared ZODB; :ref:`zodb` chapter + +* a Redis or Memcached server, to handle cache and sessions; + :ref:`pyams_cache` chapter + + +Quickstart deployment +--------------------- + +Overview of the environement system after the :ref:`quickstart` installation. +It's a very lite configuration, with only mandatory resourses. +Obviously you can extend this system by connecting more resources like is described in the :ref:`config` chapiter + + +.. image:: _static/architecture_quickstart.png + + + +Developpement deployment +------------------------ + +In additon of mandatory resource **PyAMS** could work with: + +* a websockets server (GuniCorn), used to handle desktop notifications; + you can find information about this component in the :ref:`pyams_notify` chapter; + +* an Elasticsearch index, used to handle quick and optimized searching. + + +.. image:: _static/architecture_dev.png + + +Production deployment +--------------------- + +Use case in a more complete prodution environement. + +.. image:: _static/architecture_prod.png + diff -r 000000000000 -r b2be9a32f3fc src/source/conf.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/conf.py Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,245 @@ +#!/var/local/env/pycharm/bin/python3.5 +# -*- coding: utf-8 -*- +# +# PyAMS User Guide documentation build configuration file, created by +# sphinx-quickstart on Fri Dec 15 17:15:54 2017. +# +# 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. + +# 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. +# +import sys +#sys.path.insert(0, '/var/local/env/pycharm/lib/python3.5/site-packages') + +import os + +prefix_path = os.path.abspath('../../../') + os.path.sep +sys.path[0:0] = list(map(lambda x: prefix_path + x, + [ + 'pyams_alchemy/src', + 'pyams_cache/src', + 'pyams_catalog/src', + 'pyams_content/src', + 'pyams_content_es/src', + 'pyams_default_theme/src', + 'pyams_file/src', + 'pyams_form/src', + 'pyams_gis/src', + 'pyams_i18n/src', + 'pyams_ldap/src', + 'pyams_mail/src', + 'pyams_media/src', + 'pyams_notify/src', + 'pyams_notify_ws/src', + 'pyams_pagelet/src', + 'pyams_portal/src', + 'pyams_scheduler/src', + 'pyams_security/src', + 'pyams_sequence/src', + 'pyams_skin/src', + 'pyams_template/src', + 'pyams_thesaurus/src', + 'pyams_utils/src', + 'pyams_viewlet/src', + 'pyams_workflow/src', + 'pyams_zmi/src', + 'pyams_zmq/src', + 'pyams_zodbbrowser/src', + ]) + ) + +# -- 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', + 'sphinx.ext.viewcode', + 'repoze.sphinx.autointerface', +] + +autoclass_content = 'both' + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'PyAMS Documentation' +copyright = '2018, Thierry Florac' +author = 'Thierry Florac' + +# 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.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'default' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = 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 = "sphinx_rtd_theme" + +# 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 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'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# html_domain_indices = True + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'PyAMSDocumentation' + + +# -- 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': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'PyAMSDocumentation.tex', 'PyAMS Documentation', + 'Thierry Florac', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'PyAMSDocumentation', 'PyAMS Documentation', + [author], 1) +] + + +# -- 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 = [ + (master_doc, 'PyAMSDocumentation', 'PyAMS Documentation', + author, 'PyAMSDocumentation', 'PyAMS a CMS based on Pyramid and Zope', + 'Miscellaneous'), +] + + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +# 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 list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +try: + from zope.schema.fieldproperty import FieldProperty +except ImportError: + raise +else: + def get_field_doc(self): + field = self._FieldProperty__field + if field.title and field.description: + return '{0}: {1}'.format(field.title, field.description) + elif field.title: + return field.title + else: + return super(self.__class__, self).__doc__ + FieldProperty.__doc__ = property(get_field_doc) + + +def setup(app): + + app.add_stylesheet('css/custom.css') + diff -r 000000000000 -r b2be9a32f3fc src/source/developerguide.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/developerguide.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,13 @@ +.. _developerguide: + + +Developer's Guide +================= + +.. toctree:: + :maxdepth: 2 + + Package directory layout + appextend + traverser + tales diff -r 000000000000 -r b2be9a32f3fc src/source/howto-adapter.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/howto-adapter.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,180 @@ +.. _adapterhowto: + + +How to define an annotations adapter? +===================================== + +Adapters are important concepts of ZCA and PyAMS framework. If you don't know what are adapters, see :ref:`zca`. + + +What are annotations? ++++++++++++++++++++++ + +When an adapter have to add persistent attributes to a persistent class, it can add these attributes directly into +persistent instances. But this way can lead to conflicts when several adapters want to use the same attribute name for +different kinds of information. + +Annotations are an elegant way to handle this use case: they are based on a BTree which is stored into a +specific instance attribute (*__annotations__*). Any adapter can then use this dictionary to store it's own +informations, using it's own namespace as dictionary key. + +ZODB browser allows you to display existing annotations: + +.. image:: _static/annotations-1.png + +This example displays several annotations, each using it's own namespace: + +.. image:: _static/annotations-2.png + + +Designing interfaces +++++++++++++++++++++ + +The first step with ZCA is to design your interfaces. + +The are going to base our example on PyAMS_content 'paragraphs' component: a content class is marked as a +*paragraphs container target*, a class that can store paragraphs. But the real storage of paragraphs is done by +another *container* class: + +.. code-block:: python + :linenos: + + from zope.annotation.interfaces import IAttributeAnnotatable + from zope.containers.constraints import containers, contains + + + class IBaseParagraph(Interface): + """Base paragraph interface""" + + containers('.IParagraphContainer') + + + class IParagraphContainer(IOrderedContainer): + """Paragraphs container""" + + contains(IBaseParagraph) + + + class IParagraphContainerTarget(IAttributeAnnotatable): + """Paragraphs container marker interface""" + + + PARAGRAPH_CONTAINER_KEY = 'pyams_content.paragraph' + + +- line 5 to 8: :class:`IBaseParagraph` is the base interface for all paragraphs; constraint implies that paragraphs + can only be stored in a container implementing :class:`IParagraphContainer` interface. +- line 11 to 14: :class:`IParagraphContainer` is the base interface for paragraphs containers; constraint implies that + such a container can only contain objects implementing :class:`IBaseParagraph` interface. +- line 17 to 18: :class:`IParagraphContainerTarget` is only a *marker* interface which doesn't provide any method or + attribute; it only inherits from :class:`IAttributeAnnotatable`, which implies that classes implementing this + interface allows other classes to add informations as annotations through a dedicated *__annotations__* attribute. +- line 21: this is the key which will be used to store our annotation. + + +Creating persistent classes ++++++++++++++++++++++++++++ + +The first step is to declare that a given content class can store paragraphs: + +.. code-block:: python + :linenos: + + from pyams_content.component.paragraph.interfaces import IParagraphContainerTarget + from zope.interface import implementer + + @implementer(IParagraphContainerTarget) + class WfNewsEvent(WfSharedContent): + """News event class""" + +Here we just say "Well, I'm a shared content, and I'm OK to store paragraphs!". + +So we can design the paragraphs container class. It's this class which will *really* store the paragraphs: + +.. code-block:: python + :linenos: + + @implementer(IParagraphContainer) + class ParagraphContainer(BTreeOrderedContainer): + """Paragraphs container""" + +The paragraphs container class inherits from a :class:`BTreeOrderedContainer` and implements +:class:`IParagraphContainer`. + +The last operation is to create the adapter, which is the *glue* between the *target* class and the paragraphs +container: + +.. code-block:: python + :linenos: + + from pyams_utils.adapter import adapter_config, get_annotation_adapter + + @adapter_config(context=IParagraphContainerTarget, provides=IParagraphContainer) + def paragraph_container_factory(target): + """Paragraphs container factory""" + return get_annotation_adapter(target, + PARAGRAPH_CONTAINER_KEY, + ParagraphContainer, + name='++paras++') + +PyAMS provides a shortcut to create an annotation adapter in :func:`pyams_utils.adapter.get_annotation_adapter`. +It's mandatory arguments are: + +- **context** (line 6): the context to which the adapter is applied +- **key** (line 7): the string key used to access and store context's annotations +- **factory** (line 8): if the requested annotation is missing, a new one is created using this factory (which can be a class or + a function) + +Optional arguments are: + +- **markers** (None by default): if set, should be a list of marker interfaces which will be assigned to object + created by the factory +- **notify**: if *True* (default), an :class:`ObjectCreatedEvent` event is notified on object creation +- **locate**: if *True* (default), context is set as *parent* of created object +- **parent**: if *locate* is True and if *parent* is set, this is the object to which the new object should be *parented* + instead of initial context +- **name** (None by default): some objects need to be traversed, especially when you have to be able to access them through an URL; this + is the name given to created object. + + +Using your adapter +++++++++++++++++++ + +Starting from your *content* object, it's then very simple to access to the paragraphs container: + +.. code-block:: python + :linenos: + + event = WfNewsEvent() + paragraphs_container = IParagraphContainer(event, None) + +And that's it! From now I can get access to all paragraphs associated with my initial content!! + + +Managing traversal +++++++++++++++++++ + +As said before, sometimes you have to be able to *traverse* from an initial content to a given sub-content +managed by an adapter. + +PyAMS defines a custom :class:`pyams_utils.traversing.NamespaceTraverser`: when a request traversing subpath is +starting with '++' characters, it is looking for a named traverser providing :class:`ITraversable` interface +to the last traversed object. + +.. code-block:: python + :linenos: + + @adapter_config(name='paras', context=IParagraphContainerTarget, provides=ITraversable) + class ParagraphContainerNamespace(ContextAdapter): + """++paras++ namespace adapter""" + + def traverse(self, name, furtherpath=None): + return IParagraphContainer(self.context) + +- line 1: the adapter is named "paras"; this is matching the *++paras++* name which was given to our annotation adapter +- line 2: the adapter is just a simple context adapter, so inheriting from :class:`pyams_utils.adapter.ContextAdapter` +- lines 5 to 6: the *traverse* method is used to access the adapted content; if a name like "++ns++value" is given + to an adapted object, the "value" part is given as *name" argument. + +From now, as soon as an URL like "/mycontent/++paras++/" will be used, you will get access to the paragraphs container. +This is a standard BTree container, so will get access to it's sub-objects by key. diff -r 000000000000 -r b2be9a32f3fc src/source/howto-content.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/howto-content.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,5 @@ +.. _contenthowto: + + +How to create a new content type? +================================= diff -r 000000000000 -r b2be9a32f3fc src/source/howto-form.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/howto-form.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,103 @@ +.. _formhowto: + + +How to create a form to a component +=================================== + + +When creating a new object to the zodb, the construction of the form can't be based on an object passed context. +To build the form we use a default factory that is attached to the container of the element. + + +1) Container factory +-------------------- + +Declaration of the **factory** of `ContactPhoneParagraph` + +.. code-block:: python + + @utility_config(name=CONTACT_PHONE_PARAGRAPH_TYPE, provides=IParagraphFactory) + class ContactPhoneParagraphFactory(BaseParagraphFactory): + """Contact paragraph factory""" + + name = _("Contact Phone card") + content_type = ContactPhoneParagraph + secondary_menu = True + + + +For example :py:class:`IParagraphContainerTarget`, it's a marker interface for paragraph containers. +We could use this interface as context to declare a new pagelet. + + +.. code-block:: python + + from pyams_form.form import ajax_config + + + @pagelet_config(name='add-contact-phone-paragraph.html', context=IParagraphContainerTarget, layer=IPyAMSLayer, + permission=MANAGE_CONTENT_PERMISSION) + @ajax_config(name='add-contact-phone-paragraph.json', context=IParagraphContainerTarget, layer=IPyAMSLayer, + base=BaseParagraphAJAXAddForm) + class ContactPhoneParagraphAddForm(AdminDialogAddForm): + """Contact paragraph add form""" + + legend = _("Add new phone contact card") + dialog_class = 'modal-large' + icon_css_class = 'fa fa-fw fa-phone' + edit_permission = MANAGE_CONTENT_PERMISSION + + #Retrieve fields from the interface of the component + fields = field.Fields(IContactPhoneParagraph).omit('__parent__', '__name__', 'visible') + + + def create(self, data): + """Create one instance of the component""" + return ContactPhoneParagraph() + + def add(self, object): + """Add the new component to the container that implement the interface `IParagraphContainer` """ + IParagraphContainer(self.context).append(object) + +The associate form field are generated automatically based on this interface attributes + +:py:function:`@ajax_config()` allows the form is working with ajax requests by providing `json` content. + + + +2) Edit form +------------ + +.. code-block:: python + + @adapter_config(context=(IContactPhoneParagraph, IPyAMSLayer), provides=IParagraphInnerEditor) + permission=MANAGE_CONTENT_PERMISSION) + @ajax_config(name='inner-properties.json', context=IContactPhoneParagraph, layer=IPyAMSLayer, + base=BaseParagraphAJAXEditForm) + @implementer(IInnerForm) + class ContactPhoneParagraphInnerEditForm(ContactPhoneParagraphPropertiesEditForm): + """Contact paragraph inner edit form""" + + legend = None + + @property + def buttons(self): + if self.mode == INPUT_MODE: + return button.Buttons(IParagraphEditFormButtons) + else: + return button.Buttons() + + def get_ajax_output(self, changes): + output = super(ContactParagraphInnerAJAXEditForm, self).get_ajax_output(changes) + updated = changes.get(IBaseParagraph, ()) + if 'title' in updated: + output.setdefault('events', []).append(get_json_paragraph_refresh_event(self.context, self.request)) + updated = changes.get(IContactParagraph, ()) + if ('photo' in updated) or ('renderer' in updated): + # we have to commit transaction to be able to handle blobs... + if 'photo' in updated: + ITransactionManager(self.context).get().commit() + output.setdefault('events', []).append(get_json_form_refresh_event(self.context, self.request, + ContactParagraphInnerEditForm)) + return output + diff -r 000000000000 -r b2be9a32f3fc src/source/howto-paragraph.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/howto-paragraph.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,345 @@ +.. _paragraphhowto: + + +How to create a Paragraph type? +=============================== + +Paragraphs or Blocks are components that contain elements/fields and provide one or many renderer methods to compose +the front office website + + +Create a Paragraph +"""""""""""""""""" + +In this example we will create a contact paragraph to display at the user, who to contact. + +1) Interface +------------ + +At first we create a new paragraph interface. + +.. code-block:: python + + CONTACT_PHONE_PARAGRAPH_TYPE = 'PhoneContact' + CONTACT_PHONE_PARAGRAPH_RENDERERS = 'PyAMS.paragraph.contact.phone.renderers' + + + class IContactPhoneParagraph(IBaseParagraph): + """Contact with phone number paragraph interface""" + + name = TextLine(title=_("Contact identity"), + description=_("Name of the contact"), + required=True) + + photo = ImageField(title=_("Photo"), + description=_("Use 'browse' button to select contact picture"), + required=False) + + phone = TextLine(title=_("Phone Number"), + description=_("Name of the contact", required=False)) + + renderer = Choice(title=_("Contact template"), + description=_("Presentation template used for this contact"), + vocabulary=CONTACT_PHONE_PARAGRAPH_RENDERERS, + default='default') + + + + +2) Implement the interface +-------------------------- + +An implementation of the interface + +.. code-block:: python + + @implementer(IContactPhoneParagraph) + @factory_config(provided=IContactPhoneParagraph) + class ContactPhoneParagraph(BaseParagraph): + """Contact paragraph""" + + + icon_class = 'fa-phone' + icon_hint = _("Phone number card") + + name = FieldProperty(IContactPhoneParagraph['name']) + _photo = FileProperty(IContactPhoneParagraph['photo']) + + renderer = FieldProperty(IContactParagraph['renderer']) + + @property + def photo(self): + return self._photo + + @photo.setter + def photo(self, value): + self._photo = value + if IImage.providedBy(self._photo): + alsoProvides(self._photo, IResponsiveImage) + + +3) Renderers Vocabulary +----------------------- + +The list of rendered available for a paragraph is build automatically and is based on adapters that provide this interface + +.. code-block:: python + + @vocabulary_config(name=CONTACT_PARAGRAPH_RENDERERS) + class ContactParagraphRendererVocabulary(RenderersVocabulary): + """Contact Phone paragraph renderers vocabulary""" + + content_interface = IContactPhoneParagraph + + +.. seealso:: + + :ref:`rendererhowto` + + +Paragraph in the ZMI +"""""""""""""""""""" + + +To display and manage the new paragraph in the ZMI, you should create this associated forms + +1) Paragraph factory +-------------------- + +To create a new element instance inside the zodb, we need a container to this object. PyAMS provide +`IParagraphContainerTarget`, it's the default container for all paragraphs. We could use this container interface +as context to create a new paragraph. + + +Declaration of the **factory** of `ContactPhoneParagraph` + +.. code-block:: python + + @utility_config(name=CONTACT_PHONE_PARAGRAPH_TYPE, provides=IParagraphFactory) + class ContactPhoneParagraphFactory(BaseParagraphFactory): + """Contact paragraph factory""" + + name = _("Contact Phone card") + content_type = ContactPhoneParagraph + secondary_menu = True + + +Definition of a form to create a new ContactPhone instance + +.. code-block:: python + + from pyams_form.form import ajax_config + + + @pagelet_config(name='add-contact-phone-paragraph.html', context=IParagraphContainerTarget, layer=IPyAMSLayer, + permission=MANAGE_CONTENT_PERMISSION) + @ajax_config(name='add-contact-phone-paragraph.json', context=IParagraphContainerTarget, layer=IPyAMSLayer, + base=BaseParagraphAJAXAddForm) + class ContactPhoneParagraphAddForm(AdminDialogAddForm): + """Contact phone paragraph add form""" + + legend = _("Add new contact phone card") + dialog_class = 'modal-large' + icon_css_class = 'fa fa-fw fa-phone' + + fields = field.Fields(IContactPhoneParagraph).omit('__parent__', '__name__', 'visible') + edit_permission = MANAGE_CONTENT_PERMISSION + + def create(self, data): + return ContactPhoneParagraph() + + def add(self, object): + IParagraphContainer(self.context).append(object) + + +2) Create the Paragraph addform button in the menu +-------------------------------------------------- + +We have created a new form and we want add a quick access button to create a new paragraph + +.. code-block:: python + + @viewlet_config(name='add-contact-phone-paragraph.menu', context=IParagraphContainerTarget, view=IParagraphContainerView, + layer=IPyAMSLayer, manager=IToolbarAddingMenu, weight=600) + class ContactPhoneParagraphAddMenu(BaseParagraphAddMenu): + """Contact paragraph add menu""" + + label = _("Contact card...") + label_css_class = 'fa fa-fw fa-id-card-o' + url = 'add-contact-paragraph.html' + paragraph_type = CONTACT_PARAGRAPH_TYPE + + + +3) Create Edit inner form +------------------------- + +.. code-block:: python + + @adapter_config(context=(IContactPhoneParagraph, IPyAMSLayer), provides=IParagraphInnerEditor) + permission=MANAGE_CONTENT_PERMISSION) + @ajax_config(name='inner-properties.json', context=IContactPhoneParagraph, layer=IPyAMSLayer, + base=BaseParagraphAJAXEditForm) + @implementer(IInnerForm) + class ContactPhoneParagraphInnerEditForm(ContactPhoneParagraphPropertiesEditForm): + """Contact paragraph inner edit form""" + + legend = None + + @property + def buttons(self): + if self.mode == INPUT_MODE: + return button.Buttons(IParagraphEditFormButtons) + else: + return button.Buttons() + + def get_ajax_output(self, changes): + output = super(ContactParagraphInnerAJAXEditForm, self).get_ajax_output(changes) + updated = changes.get(IBaseParagraph, ()) + if 'title' in updated: + output.setdefault('events', []).append(get_json_paragraph_refresh_event(self.context, self.request)) + updated = changes.get(IContactParagraph, ()) + if ('photo' in updated) or ('renderer' in updated): + # we have to commit transaction to be able to handle blobs... + if 'photo' in updated: + ITransactionManager(self.context).get().commit() + output.setdefault('events', []).append(get_json_form_refresh_event(self.context, self.request, + ContactParagraphInnerEditForm)) + return output + + +4) Create an Edit modal form +----------------------------- + +This form is used inside modals popup + + +.. code-block:: python + + @ajax_config(name='properties.json', context=IContactPhoneParagraph, request_type=IPyAMSLayer, + permission=MANAGE_CONTENT_PERMISSION, renderer='json', xhr=True) + @pagelet_config(name='properties.html', context=IContactParagraph, layer=IPyAMSLayer, + permission=MANAGE_CONTENT_PERMISSION) + class ContactPhoneParagraphPropertiesEditForm(BaseParagraphPropertiesEditForm): + """Contact phone paragraph properties edit form""" + + prefix = 'contact_properties.' + + legend = _("Edit contact card properties") + icon_css_class = 'fa fa-fw fa-id-card-o' + + fields = field.Fields(IContactParagraph).omit('__parent__', '__name__', 'visible') + fields['renderer'].widgetFactory = RendererFieldWidget + + edit_permission = MANAGE_CONTENT_PERMISSION + + +.. note:: + + Select the new content block types in ZMI to make it available in tools + + .. image:: _static/select_paragraph.png + + +How to associate links or Illustrations to a Paragraph ? +======================================================== + +Adding the following marker interface, we add new behavior to the Paragraph `ContactPhoneParagraph` . + + +Paragraph advanced +"""""""""""""""""" + +You can attach Associated files, links or illustration and manage them directly through the rubric `Links and Attachments`. + +.. image:: _static/select_links_n_attachment.png + + +1) Paragraph with Links and Attachements +---------------------------------------- + +To "activate" this features the paragrath object must to implement specific interface + + +.. code-block:: python + + @implementer(IContactPhoneParagraph, IIllustrationTarget,ILinkContainerTarget,IExtFileContainerTarget)) + @factory_config(provided=IContactPhoneParagraph) + class ContactPhoneParagraph(BaseParagraph): + """Contact paragraph""" + ... + + +These interfaces will allow to link other data to the paragraph. + +**Marker interfaces:** + + +--------------------------------+ + |:py:class:`IIllustrationTarget` | + +===================+============+ + | | | + +-------------------+------------+ + + +---------------------------------+ + |:py:class:`ILinkContainerTarget` | + +==============+==================+ + | | Add internal link| + | +------------------+ + | | Add external link| + | +------------------+ + | | Add mailto link | + +--------------+------------------+ + + +------------------------------------+ + |:py:class:`IExtFileContainerTarget` | + +================+===================+ + | | Add external file | + | +-------------------+ + | | Add image | + | +-------------------+ + | | Add video | + | +-------------------+ + | | Add audio file | + +----------------+-------------------+ + + +**ZMI overview:** + +.. image:: _static/select_add_links.png + + + +2) Add link and association form +-------------------------------- + +You can add form to manage links and attachments directly in paragraph form to do that your form must implement +``IPropertiesEditForm`` and/or ``IAssociationParentForm`` + + +.. code-block:: python + + @adapter_config(context=(IContactPhoneParagraph, IPyAMSLayer), provides=IParagraphInnerEditor) + @implementer(IInnerForm, IPropertiesEditForm, IAssociationParentForm) + class ContactPhoneParagraphInnerEditForm(ContactPhoneParagraphPropertiesEditForm): + """Contact paragraph inner edit form""" + + legend = None + ajax_handler = 'inner-properties.json' + + +**Marker interfaces:** + ++-----------------------------------+ +|:py:class:`IPropertiesEditForm` | ++=========+=========================+ +| | Add Illustration form | ++---------+-------------------------+ + ++-----------------------------------+ +|:py:class:`IAssociationParentForm` | ++===========+=======================+ +| | Add Association form | ++-----------+-----------------------+ + +.. image:: _static/associations_form.png + diff -r 000000000000 -r b2be9a32f3fc src/source/howto-portlet.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/howto-portlet.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,180 @@ +.. _portlethowto: + + +How to create a Portlet? +======================== + +**Portlets** are pluggable user interface software components that are managed and displayed in a web portal, +for example an enterprise portal or a web CMS. A portlet can aggregate (integrate) and personalize content from +different sources within a web page. A portlet responds to requests from a web client and generates dynamic content +(*reference:* `Wiki portlet`_). + +.. _`wiki portlet`: https://en.wikipedia.org/wiki/Portlet + + +**PyAMS Portal** provides the portal engine but only a very small set of predefined portlets that can be used to compose +and organize the structure of a web page; additional portlets are provided by other packages, like +:ref:`pyams_content`. + + +1. Define portlet settings +'''''''''''''''''''''''''' + +Portlet settings interface are defined in ``interfaces.py``, you can use :py:class:`pyams_portal.interfaces.IPortletSettings` +or extend the interface by adding additional properties for example: + +.. code-block:: python + + from zope.schema import Text + + NEW_PORTLET_NAME = 'new.portlet' + + class INewPortletSettings(IPortletSettings): + + comment = Text(title=_("Comment"), + required=True) + + +A :py:class:`pyams_portal.portlet.PortletSettings` persistent subclass then implements what IPortletSettings describes: + +.. code-block:: python + + @implementer(INewPortletSettings) + class NewPortletSettings(PortletSettings): + """Portlet settings""" + + comment = FieldProperty(INewPortletSettings['comment']) + + +2. Create Portlet +''''''''''''''''' + +The Portlet component is a utility, which implements the :py:class:`pyams_portal.interfaces.IPortlet` interface and is +registered by the :py:func:`pyams_portal.portlet.portlet_config` decorator; + +.. code-block:: python + + @portlet_config(permission=VIEW_PERMISSION) + class ImagePortlet(Portlet): + """Image portlet""" + + name = NEW_PORTLET_NAME + label = _("New portlet") + + toolbar_image = None + toolbar_css_class = 'fa fa-fw fa-2x fa-picture-o' + + settings_class = NewPortletSettings + + +Where: + - **permission**: permission required to display this portlet content + - **name**: internal name given to this portlet. This name must be unique between all portlets, so using your own + namespace into this name is generally a good option! + - **label**: user label given to this portlet + - **toolbar_image**: URL of an image used to display portlet button into ZMI toolbar, if any + - **toolbar_css_class**: CSS class used to display portlet button into ZMI toolbar, if any + - **settings_class**: class used to store portlet settings. + + +3. Create portlet settings edit form +'''''''''''''''''''''''''''''''''''' + +Portlet settings have to be updated through management interface via a :py:class:`pyams_portal.zmi.portlet.PortletSettingsEditor` +subform: + +.. code-block:: python + + @pagelet_config(name='properties.html', context=INewPortletSettings, layer=IPyAMSLayer, + permission=VIEW_SYSTEM_PERMISSION) + class NewPortletSettingsEditor(PortletSettingsEditor): + """New portlet settings editor""" + + settings = INewPortletSettings + + + @adapter_config(name='properties.json', context=(INewPortletSettings, IPyAMSLayer), provides=IPagelet) + class NewPortletSettingsAJAXEditor(AJAXEditForm, NewPortletSettingsEditor): + """New portlet settings editor, JSON renderer""" + + +4. Previewing portlet content +''''''''''''''''''''''''''''' + +A *previewer* is used into ZMI to display portlet content into portal template definition page: + +.. code-block:: python + + @adapter_config(context=(Interface, IPyAMSLayer, Interface, INewPortletSettings), provides=IPortletPreviewer) + @template_config(template='my-portlet-preview.pt', layer=IPyAMSLayer) + class NewPortletPreviewer(PortletPreviewer): + """New portlet previewer""" + + +The previewer template is a Chameleon template: + +.. code-block:: genshi + + + +
Comment
+ + +
+ + + + +
+ + + +Here we check if portlet is visible or not to display a small icon when hidden; otherwise we display entered comment. + + +5. Rendering portlet content +'''''''''''''''''''''''''''' + +A *renderer* is used to display portlet content into rendered page content: + +.. code-block:: python + + @adapter_config(context=(IPortalContext, IPyAMSLayer, Interface, INewPortletSettings), provides=IPortletRenderer) + @template_config(template='my-portlet-render.pt', layer=IPyAMSLayer) + class NewPortletRenderer(PortletRenderer): + """New portlet renderer""" + + label = _("Default comment renderer") + + +Each renderer template is also a Chameleon template: + +.. code-block:: genshi + +
Comment
+ + +This is the configuration of a *default* renderer defined for this portlet; you can provide several renderers for a +given portlet by given distinct names to the adapters: + +.. code-block:: python + + @adapter_config(name='another-renderer', + context=(IPortalContext, IPyAMSLayer, Interface, INewPortletSettings), + provides=IPortletRenderer) + @template_config(template='my-portlet-render-2.pt', layer=IPyAMSLayer) + class AnotherNewPortletRenderer(PortletRenderer): + """Another new portlet renderer""" + + label = _("Another comment renderer") + +.. tip:: + You can use an other template without create a new renderer component, + with :py:func:`pyams_utils` to override the default template with you own. + + +.. note:: + + Select the new portlet in ZMI to make it available in the website template editor + + .. image:: _static/select_portlet.png diff -r 000000000000 -r b2be9a32f3fc src/source/howto-rename.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/howto-rename.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,67 @@ +.. _renamehowto: + + +How to rename classes of existing objects ? +=========================================== + + +PyAMS provides `zodbupdate` script to update easily update the change in ZODB. Because, when you develop new features +to PyAMS we sometimes have to rename or modify classes of already stored objects and if you do that you will never access +yours objects + + +**1) Include you package in the require resource for you webapp** + + +.. code-block:: python + + requires = [ + 'mypackage', + ... + ] + +**2) Add the Entry points** + + +In the `setup.py` file add 'zodbupdate' params into entry_points where is store zodbupdate directives + +.. code-block:: python + + entry_points={ + 'zodbupdate': [ + 'renames = mypackage.generations:RENAMED_CLASSES' + ] + } + + + +**3) Create a module named** ``generation`` **with the migration directives** + + +.. code-block:: python + + RENAMED_CLASSES = { + 'mypackage.mymodule MyOldClass': 'mypackage.mymodule MyNewClass' + } + + +**4) Run the commands** ``buildout`` . + +.. code-block:: console + + $ mypackage/bin/buildout + $ webapp/bin/buildout + + +The ``buildout`` command going to install correctly the package and add the new entry_points references in entry_points.txt + +**5) Run the commands** ``zodbupdate`` + +To finish run `zodbupdate` to apply the changes describe in `RENAMED_CLASSES` + +.. code-block:: console + + $ bin/zodbupdate --config etc/zodbupdate-zeo.conf + + +Where `zodbupdate-zeo.conf` is the configuration file to access to the ZODB. diff -r 000000000000 -r b2be9a32f3fc src/source/howto-renderer.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/howto-renderer.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,135 @@ +.. _rendererhowto: + + +How to create a Renderer? +========================= + + +**Renderer** are the layout of the utility data content. A renderer combine un context, a skin and +a template to produce the front office html + + To create new renderer you can override an already exist renderer or create a new one from scratch. Steps below + we will create a renderer for a `IContact` paragraph + + +1. Override a Renderer +---------------------- + +The simplest is to create a new class that inherits from the existing **Renderer** and modify this template. +After that all you have to define a new adapter name and a new label. + + +.. code-block:: python + :linenos: + + # New custom contact paragraph renderer + + @adapter_config(name='custom', context=(IContactParagraph, IPyAMSLayer), provides=ISharedContentRenderer) + @template_config(template='templates/contact-custom.pt', layer=IPyAMSLayer) + class ContactParagraphCustomRenderer(ContactParagraphDefaultRenderer): + """Context paragraph custom renderer""" + + label = _("Custom contact renderer") + #settings_interface = IContactParagraphDefaultRendererSettings + + +In this example, we have defined an adapter named 'custom' with :py:class:`IContactParagraph`, +:py:class:`IPyAMSLayer` as context and provides :py:class:`ISharedContentRenderer` interface. + +Using ``@template_config()`` decorator, the renderer will be displayed in html container according to the template +`templates/contact-custom.pt` + +The new renderer inherit of :py:class:`ContactParagraphDefaultRenderer`, have a new **label** (line 8) +and this associated **settings_interface** is not modify(line 9) + +.. tip:: + + You can override the template of a renderer easily with the function :py:func:`pyams_template.template.override_template` + It's takes the context and the new template path as params. + + + +2. Create a new Renderer from scratch +------------------------------------- + +We can define a new settings for the renderer, to do that we start by creating an interface: + + +a) Create setting interface for the renderer +"""""""""""""""""""""""""""""""""""""""""""" + +.. code-block:: python + + class IPhotoRendererSettings(Interface): + """Custom renderer settings interface""" + + + display_photo = Bool(title=_("Show photo?"), + description=_("Display contact photo"), + required=True, + default=True) + + can_display_photo = Attribute("Check if photo can be displayed") + + +We have created an interface with two attributes *display_photo* and *can_display_photo* +Then we create an implemantation of the interface + +.. code-block:: python + + @implementer(IPhotoRendererSettings) + class PhotoRendererSettings(Persistent, Location): + """Custom renderer settings""" + + display_photo = FieldProperty(IPhotoRendererSettings['display_photo']) + + @property + def can_display_photo(self): + contact = IContactParagraph(self.__parent__) + if not contact.photo: + return False + return self.display_photo + + + +b) Create an adapter for the render setting interface +""""""""""""""""""""""""""""""""""""""""""""""""""""" + +With :py:func:`@adapter_config()` we declare a new adapter that applies to a context and provide the interface of + renderer settings + +.. code-block:: python + + PHOTO_RENDERER_SETTINGS_KEY = 'pyams_content.contact.renderer:photo' + + @adapter_config(context=IContactParagraph, provides=IPhotoRendererSettings) + def custom_renderer_settings_factory(context): + """Contact paragraph default renderer settings factory""" + return get_annotation_adapter(context, PHOTO_RENDERER_SETTINGS_KEY, + CustomRendererSettings) + + +In this example the settings interface adapter is defined with `IContactParagraph` as context +and provide `IPhotoRendererSettings`. + + + +c) Create an adapter for the render interface +""""""""""""""""""""""""""""""""""""""""""""" + +.. code-block:: python + + @adapter_config(context=(IContactParagraph, IPyAMSLayer), provides=ISharedContentRenderer) + @template_config(template='templates/contact-custom.pt', layer=IPyAMSLayer) + class PhotoRenderer(BaseContentRenderer): + """Context paragraph custom renderer""" + + label = _("Custom contact renderer") + settings_interface = IPhotoRendererSettings + + +Add settings interface to the renderer `settings_interface = IPhotoRendererSettings` + +.. tip:: + When a setting_interface is associated to a renderer, you can access to `settings` attributes through the template + diff -r 000000000000 -r b2be9a32f3fc src/source/howto-skin.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/howto-skin.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,75 @@ +.. _skinhowto: + + +How to create Skin? +=================== + +A Skin is a tagging interface for associating media, javascript and CSS resources to a **renderer** + +1) Configuring resource library +------------------------------- + + +.. code-block:: python + + from fanstatic import Library, Resource + from pyams_default_theme import pyams_default_theme + + #Library(name, folder_path) + library = Library('mycms', 'resources') + + #Resource(library, path_to_static) + mycms_css = Resource(library, 'css/mystyle.css',) + + + mycms_js = Resource(library, 'js/pyams-default.js', + depends=(pyams_default_theme, ) + bottom=True + ) + + +:py:class:`Resource` can include others resources already defined with *depends* attribute, here `pyams_default_theme`. + + +2) Create a new Layer to your skin +---------------------------------- + +Build a new interface inherit from `ICustomLayer` + +.. code-block:: python + + class ICustomLayer(ICustomLayer): + """skin layer""" + +Define an utility providing ISkin with the custom label and the layer interface + +.. code-block:: python + + @utility_config(name='Custom skin', provides=ISkin) + class CustomSkin(object): + """custom root skin""" + + label = _("Custom: skin") + layer = ICustomLayer + + +3) Declare the layer adapter +---------------------------- + +.. code-block:: python + + @adapter_config(context=(Interface, ICustomLayer, Interface), provides=IResources) + class CustomSkinResourcesAdapter(ContextRequestViewAdapter): + """Custom skin resources adapter""" + + def get_resources(self): + mycms.need() + + +We have defined a Multiadapter with context=(context, request, view). + +.. note:: + + In the ZMI website you can now change the default graphical theme by you custom skin + + .. image:: _static/select_skin.png diff -r 000000000000 -r b2be9a32f3fc src/source/howto-template.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/howto-template.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,63 @@ +.. _templatehowto: + + +How to define or change a template for a specific skin? +======================================================= + +Override the default template for a renderer +-------------------------------------------- + +If you want to modify the template for a particular rendering mode, you can use the function :py:func:`override_template` + +.. code-block:: python + + from pyams_template.template import override_template + + from my_website.skin.public.layer import ICustomLayer + from pyams_default_theme.component.keynumber.portlet import KeyNumberPortletHorizontalRenderer + + + override_template(context=KeyNumberPortletHorizontalRenderer, + template="templates/keynumber-horizontal.pt", + layer=ICustomLayer + ) + + +This new template can be applied to a particular :ref:`Skin ` by specifying on which layer to use this renderer +*(ex: layer=IMyWebsiteLayer)* + + + +Redefine the default template for a renderer +-------------------------------------------- + +You must redefine an adapter to add new variables or static resources for your new template, + +.. code-block:: python + + # import interfaces + from my_website.skin.public.layer import ICustomLayer + + from pyams_content.component.keynumber.portlet.interfaces import IKeyNumberPortletSettings + from pyams_portal.interfaces import IPortletRenderer, IPortalContext + + # import packages + from my_website.skin.public import my_carousel_init ,my_carousel_animation + + from pyams_default_theme.component.keynumber.portlet import KeyNumberPortletHorizontalRenderer + from pyams_template.template import template_config + from pyams_utils.adapter import adapter_config + from zope.interface import Interface + + + @adapter_config(context=(IPortalContext, IBaseLayer, Interface, IKeyNumberPortletSettings), + provides=IPortletRenderer) + @template_config(template='templates/keynumber-horizontal.pt', layer=ICustomLayer) + class MyCustomKeyNumberPortletHorizontalRenderer(KeyNumberPortletHorizontalRenderer): + """Key numbers portlet horizontal renderer""" + + resources = (my_carousel_init, my_carousel_animation) + + +The attribute :py:attr:`resources` is used to load in the template static resources. The application will automatically +integrate resource content when the template is calling. diff -r 000000000000 -r b2be9a32f3fc src/source/index.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/index.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,64 @@ +.. PyAMS documentation master file, created by + sphinx-quickstart on Tue Nov 15 16:18:42 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. +.. _index: + + +Contents +--------- + +.. toctree:: + :maxdepth: 2 + :caption: Getting started + + Introduction + Quickstart + +.. toctree:: + :maxdepth: 2 + :caption: Tutorial + + PyAMS CMS User’s Guide + screenshots + +.. toctree:: + :maxdepth: 2 + :caption: Installation + + Architectures + Database: ZODB Server + Installing PyAMS + Configuring and Running PyAMS + Managing PyAMS environment + Additional Plugins + + +.. toctree:: + :maxdepth: 2 + :caption: Technical documentation + + Zope Component Architecture + developerguide + packages + + +.. toctree:: + :maxdepth: 2 + :caption: Toolkit + + scripts + +.. toctree:: + :maxdepth: 2 + :caption: Python Tests + + tests + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff -r 000000000000 -r b2be9a32f3fc src/source/introduction.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/introduction.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,90 @@ +.. _introduction: + +Welcome to PyAMS's documentation! +================================= + +.. warning:: + This is a "work-in-progress" documentation. All elements described here are not publicly available yet. + + +What is PyAMS? +-------------- + +**PyAMS** stands for **Py**\ramid **\A**\pplication **\M**\anagement **\S**\kin is a whole "Suite" of +applications and content management tools with user friendly skin. + + +What is Pyramid? +---------------- + +Pyramid is an open source Python web application framework. It is designed to make creating web applications easier. + + +Why should i use PyAMS? +----------------------- + +Based on the python langage, **PyAMS** supply powerfull tools like *PyAMS_content*, this package +providing content management features, which can be easily extended to manage your own content types. +But PyAMS can also be used to manage any kind of application. + +In addition **PyAMS** is built on top of **MyAMS** (**My** **\A**\pplication **\M**\anagement **\S**\kin), a small web client framework built on top of JQuery +and Bootstrap, which was developed by the french national forestry office (ONF -- Office national des forêts -- +http://www.onf.fr) to build web applications in several languages (actually java, Python and PHP). The new ONF website +is now completely handled with PyAMS framework. + +PyAMS is a multipurpose set of packages, providing tools including: + + * custom interfaces + * custom registry annotations + * custom security policy + * local registry support + * network protocols utilities (for HTTP and XML-RPC) + * command line scripts + * custom utilities. + + +.. tip:: + Some screenshots of the admin interface are available at :ref:`screenshots`! + + +How to install PyAMS? +--------------------- + +If you want to create a PyAMS application instance easily, just follow the :ref:`quickstart` guide! +If you want learn more about a custom installation follow :ref:`install` procedure. + + + +1.1. Overview + +Zope 2 is a free and open-source, object-oriented web application server written in the Python programming language. The term ZOPE is an acronym for “Z Object Publishing Environment” (the Z doesn’t really mean anything in particular). However, nowadays ZOPE is simply written as Zope. It has three distinct audiences. + + +Developers + Individuals who wish to extend Zope to create highly customized solutions. This audience is likely interested in creating highly reusable custom code that makes Zope do something new and interesting. They will likely make heavy use of “through the file-system” style development. + + +This guide is intended to document Zope for the second audience, Developers, as defined above. If you fit more into the “user” audience defined above, you’ll probably want to start by reading The Zope Book . + +Throughout this guide, it is assumed that you know how to program in the Python programming language. Most of the examples in this guide will be in Python. There are a number of great resources and books for learning Python; the best online resource is the python.org web site and many books can be found on the shelves of your local bookstore. +1.2. Organization of the book + +This book describes Zope’s services to the developer from a hands on, example-oriented standpoint. This book is not a complete reference to the Zope API, but rather a practical guide to applying Zope’s services to develop and deploy your own web applications. This book covers the following topics: + +Getting Started + This chapter provides a brief overview of installation and getting started with application development. +Components and Interfaces + Zope use a component-centric development model. This chapter describes the component model in Zope and how Zope components are described through interfaces. +Object Publishing + Developing applications for Zope involves more than just creating a component, that component must be publishable on the web. This chapter describes publication, and how your components need to be designed to be published. +Zope Products + New Zope components are distributed and installed in packages called “Products”. This chapter explains Products in detail. +Persistent Components + Zope provides a built-in, transparent Python object database called ZODB. This chapter describes how to create persistent components, and how they work in conjunction with the ZODB. +Acquisition + Zope relies heavily on a dynamic technique called acquisition. This chapter explores acquisition thoroughly. +Security + When your component is used by many different people through the web, security becomes a big concern. This chapter describes Zope’s security API and how you can use it to make security assertions about your object. +Debugging and Testing + Zope has built in debugging and testing support. This chapter describes these facilities and how you can debug and test your components. + diff -r 000000000000 -r b2be9a32f3fc src/source/manage.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/manage.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,12 @@ +.. _manage: + +Managing PyAMS environment +========================== + +.. toctree:: + :maxdepth: 2 + + appmanage + utilities + + diff -r 000000000000 -r b2be9a32f3fc src/source/package_layout.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/package_layout.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,21 @@ +PyAMS Package directory layout +------------------------------ + +.. code-block:: bash + + + ├── pyams_/ + │   ├── doctests/ <- Documentation for the package + | ├── generation/ <- ZODB Migration directives + │   ├── interfaces/ <- Interfaces definition + │   ├── locales/ <- Store source code translation files (.mo .pot) + │   ├── tests/ <- Contains python scripts for running tests including test runners, unit test + │   ├── zmi/ <- ZMI subpackage to register and define elements in admin interface + │   ├── __init__.py + │   ├── include.py <- Register Pyramid directives + │   ├── configure.zcml <- Overload default Zope config directive (optional) + : :.. .py <- source code + : : + │   └── site.py + + ... diff -r 000000000000 -r b2be9a32f3fc src/source/packages.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/packages.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,51 @@ +.. _packages: + +PyAMS packages +============== + + +PyAMS core +---------- + +.. toctree:: + :maxdepth: 1 + + PyAMS Security + PyAMS Utils + PyAMS Template + PyAMS Pagelet + PyAMS Viewlet + PyAMS Form + PyAMS Skin + PyAMS ZMI + PyAMS File + PyAMS Content + PyAMS Portal + PyAMS default theme + + +Additional PyAMS packages +------------------------- + +PyAMS is built on many additional packages, and provides a whole set of extensions. Here is a list of them: + +.. toctree:: + :maxdepth: 1 + + PyAMS Alchemy + PyAMS Cache + PyAMS Catalog + PyAMS Content with ElasticSearch + PyAMS GIS + PyAMS I18N + PyAMS LDAP + PyAMS Mail + PyAMS Media + PyAMS Notify + PyAMS WebSocket notifications + PyAMS Scheduler + PyAMS Sequence + PyAMS Thesaurus + PyAMS Workflow + PyAMS ZMQ + PyAMS ZODB browser diff -r 000000000000 -r b2be9a32f3fc src/source/plugins.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/plugins.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,209 @@ +.. _plugins: + +PyAMS additional features and services +====================================== + + +Elasticsearch ++++++++++++++ + +At first you need to install ElasticSearch (ES); PyAMS is actually compatible with version 5.4. The Ingest attachment +plug-in is also required to handle attachments correctly. + +Visit https://www.elastic.co/ to learn how to install Elasticsearch Server and `ingest-attachment` plug-in + + +.. tip:: Documentation for installing ElasticSearch 5.4 + + - https://www.elastic.co/guide/en/elasticsearch/reference/5.4/gs-installation.html + - https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest-attachment.html + + +After Elasticsearch installation, following steps describe how to configure ES with PyAMS. + + +Initializing Elasticsearch index +-------------------------------- + +If you want to use an Elasticsearch index, you have to initialize index settings and mappings; +Elasticsearch integration is defined through the *PyAMS_content_es* package. + + +1. Enable service +''''''''''''''''' + +In Pyramid INI application files (*etc/development.ini* and *etc/production.ini*): + +.. code-block:: ini + + # Elasticsearch server settings + elastic.server = http://127.0.0.1:9200 + elastic.index = pyams + +Where: + - **elastic.server**: address of Elasticsearch server; you can include authentication arguments in the form + *http://login:password@w.x.y.z:9200* + - **elastic.index**: name of Elasticsearch index. + + +On startup, main PyAMS application process can start in *indexer* process which will handle indexing requests in +asynchronous mode; this process settings are defined like this: + +.. code-block:: ini + + # PyAMS content Elasticsearch indexer process settings + pyams_content.es.tcp_handler = 127.0.0.1:5557 + pyams_content.es.start_handler = false + pyams_content.es.allow_auth = admin:admin + pyams_content.es.allow_clients = 127.0.0.1 + +Where: + - **pyams_content.es.tcp_handler**: IP address and listening port of PyAMS indexer process + - **pyams_content.es.start_handler**: if *true*, the indexer process is started on PyAMS startup; otherwise (typically + in a cluster configuration), the process is supposed to be started from another *master* server + - **pyams_content.es.allow_auth**: login and password to be used to connect to indexer process (settings are defined + in the same way on indexer process and on all it's clients) + - **pyams_content.es.allow_clients**: list of IP addresses allowed to connect to indexer process. + + +2. Initialize Elasticsearch database +'''''''''''''''''''''''''''''''''''' + +Configuration files for attachment pipeline, index and mappings settings are available into `pyams_content_es` source +package or in PyAMS installation folder: + + +.. code-block:: bash + + (env) $ cd docs/elasticsearch + (env) $ curl --noproxy localhost -XPUT http://localhost:9200/_ingest/pipeline/attachment -d @attachment-pipeline.json + + +And with ``elastic.index = pyams`` defined as Elasticsearch index name: *"http://localhost:9200/pyams"*: + +.. code-block:: shell + + (env) $ curl -XDELETE http://localhost:9200/pyams + + (env) $ curl -XPUT http://localhost:9200/pyams -d @index-settings.json + + (env) $ curl -XPUT http://localhost:9200/pyams/WfTopic/_mapping -d @mappings/WfTopic.json + (env) $ curl -XPUT http://localhost:9200/pyams/WfNewsEvent/_mapping -d @mappings/WfNewsEvent.json + (env) $ curl -XPUT http://localhost:9200/pyams/WfBlogPost/_mapping -d @mappings/WfBlogPost.json + + +*Troubleshooting*: If you have a 406 error try to add ``-H 'Content-Type: application/json'`` in Curl command lines. + + +3. Update index contents +'''''''''''''''''''''''' + +If your ZODB database already store contents, you can update ElasticSearch indexes with all these contents with +``pymas_es_index`` command line script. From a shell: + +.. code-block:: bash + + (env) $ ./bin/pyams_es_index ../etc/development.ini + + + +Natural Language Toolkit - NLTK ++++++++++++++++++++++++++++++++ + +PyAMS is using NLTK features through the *PyAMS_calalog*. + +.. seealso:: + + Visit https://www.nltk.org/ to learn more about NLTK + + +Initializing NLTK (Natural Language ToolKit) +-------------------------------------------- + +Some NLTK collections like **tokenizers** and **stopwords** utilities are used to index fulltext contents +elements. You can enhance NLTK indexation according to your own needs. This package requires downloading and +configuration of several elements which are done as follow: + + +*1. Run the Python shell into PyAMS environment:* + +.. code-block:: bash + + (env) $ ./bin/py + + +*2. In the Python shell:* + +.. code-block:: pycon + + >>> import nltk + >>> nltk.download() + + +*3. Configuration installation directory:* + +.. tip:: + + On Debian GNU/Linux, you can choose any directory between '*~/nltk_data*' (where '~' is the homedir of user running + Pyramid application), '*/usr/share/nltk_data*', '*/usr/local/share/nltk_data*', '*/usr/lib/nltk_data*' and + '*/usr/local/lib/nltk_data*' + + Please check if you have permission to write to this directory! + + +.. code-block:: shell + + NLTK Downloader + --------------------------------------------------------------------------- + d) Download l) List u) Update c) Config h) Help q) Quit + --------------------------------------------------------------------------- + Downloader> c + + Data Server: + - URL: + - 6 Package Collections Available + - 107 Individual Packages Available + + Local Machine: + - Data directory: /home/tflorac/nltk_data + + Config> d + New directory> /usr/local/lib/nltk_data + + +*4. Return to the main menu:* + +.. code-block:: shell + + --------------------------------------------------------------------------- + s) Show Config u) Set Server URL d) Set Data Dir m) Main Menu + --------------------------------------------------------------------------- + Config> m + + +*5. Download utilities:* + + punkt + Punkt Tokenizer Models + stopwords + Stopwords Corpus + + +.. code-block:: shell + + --------------------------------------------------------------------------- + d) Download l) List u) Update c) Config h) Help q) Quit + --------------------------------------------------------------------------- + Downloader> d + Download which package (l=list; x=cancel)? + Identifier> punkt + Downloading package punkt to /usr/local/lib/nltk_data... + Downloader> d + Download which package (l=list; x=cancel)? + Identifier> stopwords + Downloading package stopwords to /usr/local/lib/nltk_data... + + +.. tip:: + + The full list of NTLK Collection can be displayed with the ``l) list`` option. diff -r 000000000000 -r b2be9a32f3fc src/source/quickstart.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/quickstart.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,286 @@ +.. _quickstart: + +PyAMS Quickstart +================ + +Here is a quick list of operations that you can follow to create and start your first PyAMS application from scratch. +For this quick start, we will only use the most basic setup and keep several features disabled (like Elasticsearch +integration, notifications...). + +See :ref:`install` to get a full description of installation process. + + +0. Before starting +++++++++++++++++++ + +Required packages +----------------- + +PyAMS relies on system and Python packages which you must have been previously installed in your environment. + +.. note:: + + - a C/C++ compiler like **GCC** + - **Python 3.5*** with development headers; **Cython3** for better optimization of several packages + - a cache server, like **Redis** or **Memcached**. + - Several libraries with their development headers: *libjpeg*, *libpng*, *libfreetype*, *libxml2* and *libxslt* + (and *libpq* if you want to use PostgreSQL, *libldap* if you want to use LDAP authentication...). + +* PyAMS may be compatible with other versions but has only been completely tested with this version until now. + +On a Debian GNU/Linux: + +.. code-block:: bash + + $ apt-get install python3.5 python3.5-dev + $ apt-get install cython3 + $ apt-get install redis-server redis-tools + $ apt-get install libjpeg-dev libpng-dev libfreetype6-dev libxml2-dev libxslt1-dev + + +Initialize virtual environment +------------------------------ + +We are creating a virtual environment in */var/local/env* + +.. code-block:: bash + + $ mkdir /var/local/ + $ pip3 install virtualenv + $ virtualenv --python=python3.5 env + $ source env/bin/activate + +To use PyAMS templates, the *cookiecutter* tool is required: + +.. code-block:: bash + + (env)$ pip3.5 install cookiecutter + + +1. Create ZODB +++++++++++++++ + +We are creating a local ZODB using a "ZEO server" cookiecutter template. + +.. tip:: To know more about ZODB storages you can see :ref:`zodb`. + +.. note:: + + In this example, ZEO server instance will run as current UNIX user and group. For a production + environment, it's better to use dedicated service user and group. + +Run cookiecutter: + +.. code-block:: bash + + (env)$ cookiecutter hg+http://hg.ztfy.org/pyams/scaffolds/zeo_server + + +Configuration: + +.. code-block:: bash + + pyams_release [latest]: + project_name [ZEO_server]: ZEO_pyams + project_slug [zeo_pyams]: + eggs_directory [eggs]: /var/local/eggs # Python eggs will be stored into */var/local/eggs* directory. + run_user [zeo]: mylogin # current user ID + run_group [zeo]: mygroup # current user group + zeo_server_port [8100]: + zeo_storage [pyams]: + zeo_pack_report [root@localhost]: email@my-domain.com + logs_directory [/var/log/zeo/zeo_pyams]: # An absolute path is mandatory!!! + + Your ZEO environment is initialized. + To finalize it\'s creation, just type: + - cd zeo_pyams + - python3.5 bootstrap.py + - ./bin/buildout + + +In *zeo_pyams* folder, execute *bootstrap.py*: + +.. code-block:: bash + + (env)$ cd zeo_pyams + + (env)$ python3.5 bootstrap.py + Creating directory '/var/local/env/zeo_pyams/bin'. + Creating directory '/var/local/env/zeo_pyams/parts'. + Creating directory '/var/local/env/zeo_pyams/develop-eggs'. + Generated script '/var/local/env/zeo_pyams/bin/buildout'. + + +And then run final *buildout*: + +.. code-block:: bash + + (env)$ ./bin/buildout + + Installing zodb. + Generated script '/var/local/env/zeo_pyams/bin/zeopack'. + Generated script '/var/local/env/zeo_pyams/bin/runzeo'. + Generated script '/var/local/env/zeo_pyams/bin/zeo-nagios'. + Generated script '/var/local/env/zeo_pyams/bin/zeoctl'. + Installing zdaemon. + Generated script '/var/local/env/zeo_pyams/bin/zdaemon'. + Installing zeo_pyams. + zc.zodbrecipes: Generated shell script '/var/local/env/zeo_pyams/etc/init.d/zeo-zeo_pyams'. + + +Start the ZEO server: + +.. code-block:: bash + + (env)$ ./etc/init.d/zeo-zeo_pyams start + + Password: + . . . + daemon process started, pid=26230 + + +2. Create application instance +++++++++++++++++++++++++++++++ + +Application instance will be created in */var/local/env/pyams* via another coockiecutter template: + +.. code-block:: bash + + (env)$ cd /var/local/env + (env)$ cookiecutter hg+http://hg.ztfy.org/pyams/scaffolds/pyams + + +.. tip:: Configuration + + 1. The variable **$((INSTALL))** is the path to current folder; it will be replaced automatically by cookiecutter + after application creation + 2. You will be invited to setup additional PyAMS plugins like **Elasticsearch** but you must install related services on + your own. See also :ref:`plugins` + + +.. code-block:: bash + + pyams_release [latest]: + project_name [PyAMS]: + project_slug [pyams]: + virtual_hostname [pyams.mydomain.com]: pyams.example.com + webapp_name [webapp]: + webapp_port [6543]: + eggs_directory [eggs]: + logs_directory [$((INSTALL))/var/log]: + run_user [www-data]: # user used to run server and write logs + run_group [www-data]: # group used to run server and write logs + Select beaker_backend: + 1 - redis + 2 - memcached + Choose from 1, 2 [1]: + beaker_server [127.0.0.1:6379]: + Select db_type: + 1 - zeo + 2 - relstorage + 3 - newt + Choose from 1, 2, 3 [1]: + db_host [127.0.0.1]: + db_port [8100]: + db_name [pyams]: zeo_pyams # db_name created in step 1 + db_username []: + db_password []: + zeo_realm [pyams]: + blobs_dir [$((INSTALL)/var/db/blobs]: + use_postgresql [True]: False + use_oracle [False]: + use_ldap [False]: + use_elasticsearch [False]: + elasticsearch_server [http://127.0.0.1:9200]: + elasticsearch_index [pyams]: + create_elasticsearch_index [False]: + define_elasticsearch_mappings [False]: + smtp_server [localhost]: + smtp_server_name [pyams]: + pyams_scheduler [127.0.0.1:5555]: + start_scheduler [True]: + pyams_medias_converter [127.0.0.1:5556]: + start_medias_converter [True]: + pyams_es_indexer [127.0.0.1:5557]: + start_es_indexer [False]: + use_notifications [True]: False + pyams_ws_notify [127.0.0.1:8081]: + lexicon_languages [en:english fr:french]: + extension_package []: + need_pyams_gis [False]: + Your server environment is initialized. + + To finalize it\'s creation, just type: + - cd pyams + - python3.5 bootstrap.py + - ./bin/buildout + +In the project's *pyams* folder, execute *bootstrap.py*: + +.. code-block:: bash + + (env)$ cd pyams + (env)$ python3.5 bootstrap.py + Creating directory '/var/local/env/pyams/bin'. + Creating directory '/var/local/env/pyams/develop-eggs'. + Generated script '/var/local/env/pyams/bin/buildout'. + +And run final *buildout*: + +.. code-block:: bash + + (env)$ ./bin/buildout + + +.. note:: + + Packages download, compilation and installation can easily take several minutes. Install errors are generally due to + missing libraries development headers. + + +.. tip:: + + See :ref:`install` to get more detailed information about installation process. + + +After *buildout*, just check INI files in *etc* directory (see :ref:`config`) + + +3. Initializing the database +++++++++++++++++++++++++++++ + +You have to initialize the database to populate **PyAMS** objects into database. From a shell: + +.. code-block:: bash + + (env) $ ./bin/pyams_upgrade etc/development.ini + + +4. Starting application ++++++++++++++++++++++++ + +Application is ready to run! Start the application: + +.. code-block:: bash + + (env)$ ./bin/pserve etc/development.ini + ... + Starting server in PID 29335. + Serving on http://0.0.0.0:6543 + + +Congrats: PyAMS is running ! + +Launch a browser and open URL http://127.0.0.1:6543/admin to get access to PyAMS management interface. + +.. image:: _static/pyams-login.png + +.. warning:: + + By default: + + - Login: admin + - Password: admin + + **You must change it as soon as possible!** + (see :ref:`pyams_security`)!!. diff -r 000000000000 -r b2be9a32f3fc src/source/screenshots.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/screenshots.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,26 @@ +.. _screenshots: + +PyAMS screenshots +================= + +Here are a few screenshots of PyAMS management interface (called "ZMI", in memory of old Zope Management Interface). + +All PyAMS features are available through it's management interface; no HTML is written "by hand" by contributors to +display any content... + + +* PyAMS dashboard: + +.. image:: _static/pyams-dashboard.png + +* PyAMS site properties: + +.. image:: _static/pyams-properties.png + +* PyAMS control panel showing registered utilities: + +.. image:: _static/pyams-control-panel.png + +* PyAMS paragraphs of a sample 'news' content, also displaying access to workflow transitions: + +.. image:: _static/pyams-paragraphs.png diff -r 000000000000 -r b2be9a32f3fc src/source/scripts.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/scripts.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,49 @@ +.. _scripts: + +PyAMS maintenance scripts +========================= + + +pyams_upgrade +------------- + + +Pyramid allows to define custom command line scripts for application management. A script called *pyams_upgrade* is +provided by PyAMS_utils package; this script apply the same process as PyAMS site factory, but can also be used to +manage **database generations**. The idea behind this is just to allow custom packages to provide a way to check and +upgrade database configuration away from application startup process: + +.. code-block:: bash + + # ./bin/pyams_upgrade webapp/development.ini + + +A **site generation checker** is just a named utility providing :py:class:`pyams_utils.interfaces.site.ISiteGenerations` +interface. For example, **pyams_security** package provides such utility, to make sure that local site manager +contains a PyAMS security manager and a principal annotation utility: + +.. code-block:: python + + from pyams_utils.site import check_required_utilities + + REQUIRED_UTILITIES = ((ISecurityManager, '', SecurityManager, 'Security manager'), + (IPrincipalAnnotationUtility, '', PrincipalAnnotationUtility, 'User profiles')) + + @utility_config(name='PyAMS security', provides=ISiteGenerations) + class SecurityGenerationsChecker(object): + """I18n generations checker""" + + generation = 1 + + def evolve(self, site, current=None): + """Check for required utilities""" + check_required_utilities(site, REQUIRED_UTILITIES) + +:py:func:`check_required_utilities ` is a PyAMS_utils utility function which +can to used to verify that a set of local utilities are correctly registered with the given names and interfaces. + + +zodbupdate +---------- + +:ref:`renamehowto` diff -r 000000000000 -r b2be9a32f3fc src/source/tales.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/tales.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,74 @@ +.. _tales: + +Custom TALES extensions +======================= + +PyAMS defines a custom expression for TALES called *extension*. + +When this expression is encountered, the renderer is looking for an +:py:class:`ITALESExtension ` +multi-adapter for the current *context*, *request* and *view*, for the current +*context* and *request*, or only for the current *context*, in this order. +If an adapter is found, the renderer call it's :py:func:`render` method with +the expression parameters as input parameters. + +For example, the *metas* extension is an *ITALESExtension* adapter defined into +:py:mod:`pyams_skin.metas` module which can be used to include all required headers in +a page template. Extension is used like this in the page layout template: + +.. code-block:: html + + + +This extension is defined like this: + +.. code-block:: python + + from pyams_skin.interfaces.metas import IHTMLContentMetas + from pyams_utils.interfaces.tales import ITALESExtension + from pyramid.interfaces import IRequest + + from pyams_utils.adapter import adapter_config, ContextRequestViewAdapter + + @adapter_config(name='metas', context=(Interface, IRequest, Interface), provides=ITALESExtension) + class MetasTalesExtension(ContextRequestViewAdapter): + '''extension:metas TALES extension''' + + def render(self, context=None): + if context is None: + context = self.context + result = [] + for name, adapter in sorted(self.request.registry.getAdapters((context, self.request, self.view), + IHTMLContentMetas), + key=lambda x: getattr(x[1], 'order', 9999)): + result.extend([meta.render() for meta in adapter.get_metas()]) + return '\n\t'.join(result) + +Some TALES extensions can require or accept arguments. For example, the *absolute_url* extension can accept +a context and a view name: + +.. code-block:: html + + + + + +The extension is defined like this: + +.. code-block:: python + + from persistent.interfaces import IPersistent + from pyams_utils.interfaces.tales import ITALESExtension + + from pyams_utils.adapter import adapter_config, ContextRequestViewAdapter + from pyramid.url import resource_url + from zope.interface import Interface + + @adapter_config(name='absolute_url', context=(IPersistent, Interface, Interface), provides=ITALESExtension) + class AbsoluteUrlTalesExtension(ContextRequestViewAdapter): + '''extension:absolute_url(context, view_name) TALES extension''' + + def render(self, context=None, view_name=None): + if context is None: + context = self.context + return resource_url(context, self.request, view_name) diff -r 000000000000 -r b2be9a32f3fc src/source/tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/tests.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,34 @@ +.. _tests: + +PyAMS tests +=========== + +.. toctree:: + :maxdepth: 1 + + PyAMS Alchemy tests + PyAMS Cache tests + PyAMS Catalog tests + PyAMS Content tests + PyAMS Content_es tests + PyAMS File tests + PyAMS Form tests + PyAMS GIS tests + PyAMS LDAP tests + PyAMS Mail tests + PyAMS Media tests + PyAMS Notify tests + PyAMS Pagelet tests + PyAMS Portal tests + PyAMS Scheduler tests + PyAMS Security tests + PyAMS Sequence tests + PyAMS Skin tests + PyAMS Template tests + PyAMS Thesaurus tests + PyAMS Utils tests + PyAMS Viewlet tests + PyAMS Workflow tests + PyAMS ZMI tests + PyAMS ZMQ tests + PyAMS ZODBbrowser tests diff -r 000000000000 -r b2be9a32f3fc src/source/traverser.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/traverser.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,47 @@ +.. _traverser: + +PyAMS namespace traverser +========================= + +PyAMS_utils provide a custom URL traverser, defined in package :py:mod:`pyams_utils.traversing`. + +The :py:class:`NamespaceTraverser ` is a custom traverser based on default +Pyramid's *ResourceTreeAdapter*, but it adds the ability to use *namespaces*. Inherited from *Zope3* concept, a +namespace is a resource path element starting with the « *++* » characters, like this: + +.. code-block:: none + + http://localhost:5432/folder/content/++ns++argument/@@view.html + +In this sample, *ns* is the namespace name. When the traverser detects a namespace, it looks for several named +adapters (or multi-adapters) to the :py:class:`ITraversable ` interface +defined in *zope.traversing* package. Adapters lookup with name *ns* is done for the current *context* and *request*, +then only for the context and finally for the request, in this order. If a traversing adapter is found, it's +:py:func:`traverse` method is called, with the *attr* value as first argument, and the rest of the traversal stack +as second one. + +This is for example how a custom *etc* namespace traverser is defined: + +.. code-block:: python + + from pyams_utils.interfaces.site import ISiteRoot + from zope.traversing.interfaces import ITraversable + + from pyams_utils.adapter import adapter_config, ContextAdapter + + @adapter_config(name='etc', context=ISiteRoot, provides=ITraversable) + class SiteRootEtcTraverser(ContextAdapter): + """Site root ++etc++ namespace traverser""" + + def traverse(self, name, furtherpath=None): + if name == 'site': + return self.context.getSiteManager() + raise NotFound + +By using an URL like '++etc++site' on your site root, you can then get access to your local site manager. + +*argument* is not mandatory for the namespace traverser. If it is not provided, the *traverse* method is called with +an empty string (with is a default adapter name) as first argument. + +Several PyAMS components use custom traversal adapters. For example, getting thumbnails from an image is done +through a traversing adapter, which results in nicer URLs than when using classic URLs with arguments... diff -r 000000000000 -r b2be9a32f3fc src/source/userguide.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/userguide.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,274 @@ +.. _userguide: + +PyAMS User's Guide +================== + +Users or Site Managers + Individuals who use PyAMS features to create a custom application or website. + + +To Begin +-------- + +Login +^^^^^ + +Begin by logging into the “administration area” or the back end of your website. +Now log into PyAMS using your username and password. + + .. image:: _static/pyams-login.png + + +Dashboard +^^^^^^^^^ + +After logging in you are on the main Administration Screen called the Dashboard. This is the starting point to create page and article +also settings your workspace. If you are lost click on "Home" to come back on the Dashboard. + + .. image:: _static/pyams-dashboard.png + + + +At the top of the screen is the “toolbar”, this navigation menu is to create new publication content (site , article, view...) +On the left side of the screen is the main navigation menu detailing each of the administrative functions you can perform. + + +Article - The shared contents +----------------------------- + + +Articles are sorted by category news, topic or long read, each category have different attributes, and they can quickly +identify the type of content. + +The News are a short article to spotlight an information. This is typically the type of content used for blog posts or news feeds + + +Create a News +^^^^^^^^^^^^^ + +To create a News, click on the "Shared contents" on the top bar and select "News" then click on **+ Add news topic** + + .. image:: _static/add_newtopic.png + +(*) The progress bar below the title is an indicator to optimize for indexation by search engines. + +When you are completed the form you will be redirected and invited to complete the properties of the article + + +Manage a News +^^^^^^^^^^^^^ + + .. image:: _static/content_properties.png + + +On this page you can modify the title and the url display, content description and write an unpublish note + +In Addition you can wrapped the articles with custom feature like: + +- A header or main illustration placed on the top of your article +- An illustration for the links that targets the article. + + +The interface also allows you to perform additional actions such as publishing and versioning but, we will come back to it later + + + +Edit the content of an article +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +PyAMS offers a user-friendly interface for editing the content of an article, to do that, move on the side bar +and the section **Composition** and click on **Contents...** + + .. image:: _static/select_paragraph.png + +An article is composed of many paragraphs or blocks. Depending on the configuration of the shared tool, +one or more paragraphs may already be present when creating a new article to help the author structure his document. + +Each paragraph corresponds to a type of media and will facilitate the modification the articulation of an article. +To add a new block, click **Add ..** + + .. image:: _static/content_paragraph.png + +(*) The list of available paragraph varies depending on the nature of the article and the configuration of the shared tools + + +Paragraph +--------- + +Header +^^^^^^ + +Rich Text +^^^^^^^^^ + +Illustration +^^^^^^^^^^^^ + +Media Gallery +^^^^^^^^^^^^^ + +Video +^^^^^ + +External video +^^^^^^^^^^^^^^ + +Audio +^^^^^ + +Associations +^^^^^^^^^^^^ + +Contact +^^^^^^^ + +Framed Text +^^^^^^^^^^^ + +Image Maps +^^^^^^^^^^ + +Key number +^^^^^^^^^^ + +Key point +^^^^^^^^^ + +Location number +^^^^^^^^^^^^^^^ + +Logos +^^^^^ + +Milestones +^^^^^^^^^^ + +Pictogram +^^^^^^^^^ + +Verbatim +^^^^^^^^ + +Raw HTML +^^^^^^^^ + +Verify the content +------------------ + +Audit +^^^^^ + +Preview +^^^^^^^ + + +Publishing an Article +--------------------- + +When you are writing an article, it's not already visible for the visitors, but when the content is ready the editor +has the possibility to make a request by clicking on the button **Change status**. + + + .. image:: _static/content_publish_toolbar.png + + +You will be asked to validate the date of publication and check if the content corresponds to your expectations, + + .. image:: _static/content_publication_form.png + + +If you work alone the validated content will be put online. + + +If you have collaborators, you have the possibility to used a publication workflow that include reviewers. The editor +make a **Request of publication** to the review for the validation of the request. Then, the reviewer receives a +notification inviting him to consult the article in question. + +The reviewer has the choice to accept or refuse the publication or also create a new version of the article. + + +.. warning:: + + **Important**: Once published the content can not be erased, + However you can always unpublish it to remove the access to visitors. + + +Web site Page / Blog +-------------------- + +To create a new page for your website click on `Site tree` + + + .. image:: _static/select_sitetree.png + + +A blog or weblog is a simple editorial structure where news and topics are stacked in a chronological order. + +Click on **+ Add...** and choose the to create a `blog` or a `site manager` + + + .. image:: _static/select_website_content.png + + + +How to link a shared content in the site ? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +Once the article is created, you will need to appear in your site or blog + +To link an article to a site or blog. + +- Click on "Rent content" + + .. image:: _static/site_add_content.png + +- Fill in the article internal reference. + + .. image:: _static/site_link_content.png + +- Article linked + + .. image:: _static/site_linked_content.png + + +Website Design - Portal Templates +--------------------------------- + +You can create a generic template shared for all users, to do that you need to have some webdesign privilege. + + +On the `Control panel`, click on `Portal Templates` + + .. image:: _static/select_portlet.png + +For example In the Portal Templates menu + + .. image:: _static/user_create_template.png + +1) Click on **+add template** +2) Name your new template +3) Add a new **slot** +4) Drag and drop a new portlet **image**. + +5) Click right on the portlet to **edit properties** or **delete** this elements. + + + +Apply a Template +^^^^^^^^^^^^^^^^ + +When you have defined a shared template, you can use it for your website + + .. image:: _static/nav_site_management.png + + +If you choose to inherit from a template, select the template that you want to apply + + + .. image:: _static/template_edit_config.png + +If you won't inherit from a shared template, you can create a local template. + + + diff -r 000000000000 -r b2be9a32f3fc src/source/utilities.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/utilities.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,57 @@ +.. _utilities: + +Custom PyAMS utilities +====================== + +PyAMS_utils provides a small set of utilities. You can create some of them as global utilities registered in +the global components registry; other ones can be created manually by a site administrator and +are then registered automatically. + + +Server timezone +--------------- + +To manage timezones correctly, and display datetimes based on current server timezone, all datetimes should +be defined and stored in UTC. + +PyAMS_utils provides a :py:class:`ServerTimezoneUtility ` which +allows you to assign a default timezone to your server. + +To display a datetime with correct timezone, you can use the :py:func:`tztime ` function, +which assign server timezone to the given parameter: + +.. code-block:: python + + from datetime import datetime + from pyams_utils.timezone import tztime + + now = datetime.utcnow() + my_date = tztime(now) # converts *now* to server timezone + +We could imagine that datetimes could be displayed with current user timezone. But it's quite impossible to know +the user timazone from a server request. The only options are: + +- you ask an authenticated user to update a timezone setting in his profile + +- you can include Javascript libraries which will try to detect browser timezone from their computer configuration, and + do an AJAX request to update data in their session. + +That should require an update of :py:func:`tzinfo` adapter to get timezone info from session, request or user profile. + + +ZEO connection +-------------- + +Several PyAMS utilities (like the tasks scheduler or the medias converter) are working with dedicated processes, +are connected to main PyAMS process through ØMQ, and use ZEO connections for their PyAMS database access. + +Clients of these processes have to send settings of the ZEO connections that they should use. + +The ZEOConnection utility can be created by the site manager through the web management interface (ZMI) from the +*Control panel*: + +.. image:: _static/zeo-add-menu.png + +ZEO connection creation form allows you to define all settings of a ZEO connection: + +.. image:: _static/zeo-add-form.png diff -r 000000000000 -r b2be9a32f3fc src/source/zca.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/zca.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,292 @@ +.. _zca: + +Zope Component Architecture with PyAMS +++++++++++++++++++++++++++++++++++++++ + +PyAMS packages are developed based on the **Zope Component Architecture** (aka **ZCA**). ZCA is used by the Pyramid framework +"under the hood" to handle interfaces, adapters and utilities. You don't **have to** use it in your own applications. +But you can. + +The ZCA is mainly adding elements like **interfaces**, **adapters** and **utilities** to the Python language. It +allows you to write a framework or an application by using **components** which can be extended easily. + +Interfaces + Interfaces are objects that specify (document) the external behavior + of objects that "provide" them. An interface specifies behavior through, a documentation in a doc string, + attribute definitions and conditions of attribute values. + +Components + Components are objects that are associated with interfaces. + +Utilities + Utilities are just components that provide an interface and that are looked up by an interface and a name + +Adapters + Adapters are components that are computed from other components to adapt them to some interface. + Because they are computed from other objects, they are provided as factories, usually classes. + + +You will find several useful resources about ZCA concepts on the internet. + +.. seealso:: + Zope Documentations: + - `Components and Interfaces `_ + - `Zope component `_ + - `Zope interface `_ + + +Utilities +--------- + +Local utilities +''''''''''''''' + +In ZCA, a **utility** is a **registered** component which provides an **interface**. This interface is the +**contract** which defines features (list of attributes and methods) provided by the component which implements it. + +When a Pyramid application starts, a **global registry** is created to register a whole set of utilities and +adapters; this registration can be done via ZCML directives or via native Python code. +In addition, PyAMS allows you to define **local utilities**, which are stored and registered in the ZODB via a +**site manager**. + + +Registering local utilities +''''''''''''''''''''''''''' + + +.. tip:: + + :ref:`site` can be used to store **local utilities** whose configuration, which is easily + available to site administrators through management interface, is stored in the ZODB. + + +A local utility is a persistent object, registered in a *local site manager*, and providing a specific interface (if +a component provides several interfaces, it can be registered several times). + +Some components can be required by a given package, and created automatically via the *pyams_upgrade* command line +script; this process relies on the *ISiteGenerations* interface, for example for the timezone utility, a component +provided by PyAMS_utils package to handle server timezone and display times correctly: + +.. code-block:: python + + from pyams_utils.interfaces.site import ISiteGenerations + from pyams_utils.interfaces.timezone import IServerTimezone + + from persistent import Persistent + from pyams_utils.registry import utility_config + from pyams_utils.site import check_required_utilities + from pyramid.events import subscriber + from zope.container.contained import Contained + from zope.interface import implementer + from zope.schema.fieldproperty import FieldProperty + + @implementer(IServerTimezone) + class ServerTimezoneUtility(Persistent, Contained): + + timezone = FieldProperty(IServerTimezone['timezone']) + + REQUIRED_UTILITIES = ((IServerTimezone, '', ServerTimezoneUtility, 'Server timezone'),) + + @subscriber(INewLocalSite) + def handle_new_local_site(event): + """Create a new ServerTimezoneUtility when a site is created""" + site = event.manager.__parent__ + check_required_utilities(site, REQUIRED_UTILITIES) + + @utility_config(name='PyAMS timezone', provides=ISiteGenerations) + class TimezoneGenerationsChecker(object): + """Timezone generations checker""" + + generation = 1 + + def evolve(self, site, current=None): + """Check for required utilities""" + check_required_utilities(site, REQUIRED_UTILITIES) + +Some utilities can also be created manually by an administrator through the management interface, and registered +automatically after their creation. For example, this is how a ZEO connection utility (which is managing settings to +define a ZEO connection) is registered: + +.. code-block:: python + + from pyams_utils.interfaces.site import IOptionalUtility + from pyams_utils.interfaces.zeo import IZEOConnection + from zope.annotation.interfaces import IAttributeAnnotatable + from zope.lifecycleevent.interfaces import IObjectAddedEvent, IObjectRemovedEvent + + from persistent import Persistent + from pyramid.events import subscriber + from zope.container.contained import Contained + + @implementer(IZEOConnection) + class ZEOConnection(object): + """ZEO connection object. See source code to get full implementation...""" + + @implementer(IOptionalUtility, IAttributeAnnotatable) + class ZEOConnectionUtility(ZEOConnection, Persistent, Contained): + """Persistent ZEO connection utility""" + + @subscriber(IObjectAddedEvent, context_selector=IZEOConnection) + def handle_added_connection(event): + """Register new ZEO connection when added""" + manager = event.newParent + manager.registerUtility(event.object, IZEOConnection, name=event.object.name) + + @subscriber(IObjectRemovedEvent, context_selector=IZEOConnection) + def handle_removed_connection(event): + """Un-register ZEO connection when deleted""" + manager = event.oldParent + manager.unregisterUtility(event.object, IZEOConnection, name=event.object.name) + +*context_selector* is a custom subscriber predicate, so that subscriber event is activated only if object concerned +by an event is providing given interface. + + +Registering global utilities +'''''''''''''''''''''''''''' + +**Global utilities** are components providing an interface which are registered in the global registry. +PyAMS_utils package provides custom annotations to register global utilities without using ZCML. For example, a skin +is nothing more than a simple utility providing the *ISkin* interface: + +.. code-block:: python + + from pyams_default_theme.layer import IPyAMSDefaultLayer + from pyams_skin.interfaces import ISkin + from pyams_utils.registry import utility_config + + @utility_config(name='PyAMS default skin', provides=ISkin) + class PyAMSDefaultSkin(object): + """PyAMS default skin""" + + label = _("PyAMS default skin") + layer = IPyAMSDefaultLayer + +This annotation registers a utility, named *PyAMS default skin*, providing the *ISkin* interface. It's the developer +responsibility to provide all attributes and methods required by the provided interface. + + +Looking for utilities +''''''''''''''''''''' + +ZCA provides the *getUtility* and *queryUtility* functions to look for a utility. But these methods only applies to +global registry. + +PyAMS package provides equivalent functions, which are looking for components into local registry before looking into +the global one. For example: + +.. code-block:: python + + from pyams_security.interfaces import ISecurityManager + from pyams_utils.registry import query_utility + + manager = query_utility(ISecurityManager) + if manager is not None: + print("Manager is there!") + +All ZCA utility functions have been ported to use local registry: *registered_utilities*, *query_utility*, +*get_utility*, *get_utilities_for*, *get_all_utilities_registered_for* functions all follow the equivalent ZCA +functions API, but are looking for utilities in the local registry before looking in the global registry. + + +Adapters +-------- + +Registering adapters +'''''''''''''''''''' + +An adapter is also a kind of utility. But instead of *just* providing an interface, it adapts an input object, +providing a given interface, to provide another interface. An adapter can also be named, so that you can choose which +adapter to use at a given time. + +PyAMS_utils provide another annotation, to help registering adapters without using ZCML files. An adapter can be a +function which directly returns an object providing the requested interface, or an object which provides the interface. + +The first example is an adapter which adapts any persistent object to get it's associated transaction manager: + +.. code-block:: python + + from persistent.interfaces import IPersistent + from transaction.interfaces import ITransactionManager + from ZODB.interfaces import IConnection + + from pyams_utils.adapter import adapter_config + + @adapter_config(context=IPersistent, provides=ITransactionManager) + def get_transaction_manager(obj): + conn = IConnection(obj) + try: + return conn.transaction_manager + except AttributeError: + return conn._txn_mgr + +This is another adapter which adapts any contained object to the *IPathElements* interface; this interface can be +used to build index that you can use to find objects based on a parent object: + +.. code-block:: python + + from pyams_utils.interfaces.traversing import IPathElements + from zope.intid.interfaces import IIntIds + from zope.location.interfaces import IContained + + from pyams_utils.adapter import ContextAdapter + from pyams_utils.registry import query_utility + from pyramid.location import lineage + + @adapter_config(context=IContained, provides=IPathElements) + class PathElementsAdapter(ContextAdapter): + """Contained object path elements adapter""" + + @property + def parents(self): + intids = query_utility(IIntIds) + if intids is None: + return [] + return [intids.register(parent) for parent in lineage(self.context)] + +An adapter can also be a multi-adapter, when several input objects are requested to provide a given interface. For +example, many adapters require a context and a request, eventually a view, to provide another feature. This is how, +for example, we define a custom *name* column in a security manager table displaying a list of plug-ins: + +.. code-block:: python + + from pyams_zmi.layer import IAdminLayer + from z3c.table.interfaces import IColumn + + from pyams_skin.table import I18nColumn + from z3c.table.column import GetAttrColumn + + @adapter_config(name='name', context=(Interface, IAdminLayer, SecurityManagerPluginsTable), provides=IColumn) + class SecurityManagerPluginsNameColumn(I18nColumn, GetAttrColumn): + """Security manager plugins name column""" + + _header = _("Name") + attrName = 'title' + weight = 10 + +As you can see, adapted objects can be given as functions or as classes. + + +Vocabularies +------------ + +Registering vocabularies +'''''''''''''''''''''''' + +A **vocabulary** is a custom factory which can be used as source for several field types, like *choices* or *lists*. +Vocabularies have to be registered in a custom registry, so PyAMS_utils provide another annotation to register them. +This example is based on the *Timezone* component which allows you to select a timezone between a list of references: + +.. code-block:: python + + import pytz + from pyams_utils.vocabulary import vocabulary_config + from zope.schema.vocabulary import SimpleTerm, SimpleVocabulary + + @vocabulary_config(name='PyAMS timezones') + class TimezonesVocabulary(SimpleVocabulary): + """Timezones vocabulary""" + + def __init__(self, *args, **kw): + terms = [SimpleTerm(t, t, t) for t in pytz.all_timezones] + super(TimezonesVocabulary, self).__init__(terms) diff -r 000000000000 -r b2be9a32f3fc src/source/zmi_integration.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/zmi_integration.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,19 @@ +.. _zmi_integration: + +Integrate component into admin interface (ZMI) +============================================== + +Define an interface +------------------- + +Define a component +------------------- + +Define an adptater +------------------- + +Define a view +------------- + +Define a template +----------------- diff -r 000000000000 -r b2be9a32f3fc src/source/zodb.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/zodb.rst Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,209 @@ +.. _zodb: + + +ZODB server +============ + + +Installation +'''''''''''' + +PyAMS relies mainly on a ZODB (**\Z**\ope **\O**\bjects **\D**\ata\ **\B**\ase) to store it's configuration and for exemple *PyAMS_content*, but other packages may +rely on other database(s). + +Concurrent accesses are **required** on the ZODB, to fully enjoy PyAMS. +Several ZODB storages implementations providing a shared access are available and the installation are describe below: + + * `ZEO Server`_ + * `RelStorage`_ + * `Newt.DB`_ + + +.. note:: + + When you start your application in "*single process*" mode, PyAMS packages start several processes + and the "*synchronization*" is done via **ØMQ**. + + + +.. _`ZEO Server`: + +1. ZEO server ++++++++++++++ + +ZEO (**\Z**\ope **\E**\nterprise **\O**\bjects) is the first available implementation available for concurrent access to a +FileStorage, provided through the ZEO package. + +.. seealso:: + + ZEO package documentation and complete configuration settings are available on PyPI_ (cf: `ZOE 5.2.0`_). + +.. _PyPI: https://pypi.python.org/pypi/ZEO +.. _`ZOE 5.2.0`: https://pypi.python.org/pypi/ZEO/5.2.0 + + +a) Installation with initial buildout +------------------------------------- + +PyAMS provides a ZEO server scaffold, called *zeo_server*, generated via a *cookiecutter* template. + +A simple option to create a ZEO server is to create a buildout environment including *ZEO* and *ZODB* packages: + +.. code-block:: bash + + $ mkdir /var/local/ + $ pip3 install virtualenv + $ virtualenv --python=python3.5 env + $ cd env + $ . bin/activate + (env) $ pip3.5 install cookiecutter + (env) $ cookiecutter hg+http://hg.ztfy.org/pyams/scaffolds/zeo_server + +*CookieCutter* will ask you for a small set of input variables that you can change or not: + +- **pyams_release**: version of PyAMS configuration file to use. "latest" (default value) will point to last release; + you can also choose to point to a given release ("0.1.4" for example) + +- **project_name**: current environment name in "human form" + +- **project_slug**: "technical" package name, based on project name + +- **eggs_directory**: relative or absolute path to directory containing downloaded eggs; this directory can be + shared with other projects ("eggs" as default) + +- **run_user**: user name under which ZEO process will run ("zeo" as default) + +- **run_group**: group name under which ZEO process will run ("zeo" as default) + +- **zeo_server_port**: listening port of ZEO server ("8100" as default) + +- **zeo_storage**: name of first ZEO storage ("pyams" as default) + +- **zeo_pack_report**: email address to which pack reports should be sent + +- **logs_directory**: absolute path to directory containing ZEO's log files. + +A message is displayed after initialization to finalize environment creation: + +.. code:: + + Your ZEO environment is initialized. + To finalize it''s creation, just type: + - cd zeo_server + - python3.5 bootstrap.py + - ./bin/buildout + + To initialize authentication database, please run following command after buildout: + ./bin/zeopasswd -f etc/auth.db -p digest -r "ZEO_server" zeouser xxxx + +b) ZEO server configuration +--------------------------- + +All ZEO configuration files are generated in "etc" subdirectory. These includes: + +- **etc/zeo_server-zdaemon.conf**: ZDaemon configuration file + +- **etc/zeo_server-zeo.conf**: ZEO server configuration file + +- **etc/auth.db**: ZEO authentication file; WARNING: this file is not created automatically, you have to create it + after buildout. + +In these file names, always replace "zeo_server" with the value which was given to "project_slug" variable during +*CookieCutter* template creation. + + +c) ZEO server tools +------------------- + +A set of system configuration files are produced to handle your ZEO environment. These includes: + +- **etc/init.d/zeo-zeo_server**: ZEO server start/stop script in Init-D format. Create a link to this file in + */etc/init.d* and update Init.d scripts (*update-rc.d zeo-zeo_server defaults*) to include ZEO in server start/stop + process. You can also use this script to start/stop ZEO by hand with *start* and *stop* arguments. + +- **etc/systemd/zeo-zeo_server.service**: SystemD service configuration file for ZEO server. Create a link to this + file in */etc/systemd/system* and reload SystemD daemon (*systemctl daemon-reload*) before activating ZEO service + (*systemctl enable zeo-zeo_server.service* and *systemctl start zeo-zeo_server.service*). + +- **etc/logrotate.d/zeo-zeo_server**: LogRotate configuration file for ZEO log files. Create a link to this file in + */etc/logrotate.d* to activate log rotation for ZEO server. + +- **etc/cron.d/pack-zeo-zeo_server**: Cron configuration file for ZEO database packing. Just create a link to this + file in */etc/cron.d* directory to enable ZODB packing on a weekly basis (by default). + +In these file names, always replace "zeo_server" with the value which was given to "project_slug" variable during +*CookieCutter* template creation. All directory names are those used on a Debian GNU/Linux distribution and may have +to be changed on other distributions. + + +.. _RelStorage: + +2. RelStorage server +++++++++++++++++++++ + +RelStorage (http://relstorage.readthedocs.io/en/latest) is an alternate ZODB storage implementation, that stores +Python pickles in a relational database; PostgreSQL (>= 9.0), MySQL (>= 5.0.32) and Oracle (> 10g) databases are +supported. + +To create a database compatible with RelStorage, you just have to install the database server and create a database +dedicated to RelStorage; schema initialization is then completely done by RelStorage on application startup. + +RelStorage is supposed to provide better performances than ZEO, notably under high load. RelStorage can also get +benefit from many extensions (clustering, fail-over, hot-standby...) provided by these databases. + + +.. _Newt.DB: + +3. NewtDB server +++++++++++++++++ + +NewtDB (http://www.newtdb.org/en/latest) is another ZODB storage implementation. It's using RelStorage but is +dedicated to PostgreSQL (>= 9.5). + +NewtDB adds conversion of data from the native serialization used by ZODB to JSON, stored in a PostgreSQL JSONB +column. The JSON data supplements the native data to support indexing, search, and access from non-Python application. +Because the JSON format is lossy, compared to the native format, the native format is still used for loading +objects from the database. For this reason, the JSON data are read-only. + +Newt adds a search API for searching the Postgres JSON data and returning persistent objects. It also provides a +convenient API for raw data searches. + +Database creation is done as with RelStorage, but NewtDB add several schema objects. Migration scripts are available +if you need to switch from a classic RelStorage database to a Newt database. + + +.. _ZODB.migration: + +Migration +''''''''' + +After installation, you can switch from a given storage to another one with the help of the *zodbconvert* command +line script provided by RelStorage. + +This Python script is using a configuration file containing directives of both source and target databases, which can +be any storage described in the previous sections (or can even use the same storage). + +Here is a sample configuration file to convert a ZODB from a ZEO to RelStorage: + + +.. code-block:: html + + %import relstorage + + + server zeo-server.mydomain:8100 + storage pyams + blob-dir /var/local/env/zeo/var/zeoclient/blobs + shared-blob-dir false + + + + keep-history false + blob-dir /var/local/env/pyams/var/relstorage/blobs + shared-blob-dir false + + dsn host='postgresql-server.mydomain' dbname='pyams_rs' user='pyams' password='xxxxxxxx' + + + +