diff -r 000000000000 -r d153941bb745 src/source/index.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/index.rst Sun Jan 14 11:48:51 2018 +0100 @@ -0,0 +1,123 @@ +.. PyAMS_utils 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: + + +**WARNING**: this is a "work-in-progress" documentation. All elements described here are not publicly available yet!!! + + +Welcome to PyAMS_utils's documentation! +======================================= + +At first, PyAMS was "Pyramid Application Management Skin". Actually, it's not only a simple skin but a whole "Suite" of +applications and content management tools. + +PyAMS_utils is a multipurpose utilities package, providing tools including: + +* custom interfaces +* custom ZCA registry annotations +* local registry support +* network protocols utilities (for HTTP and XML-RPC) +* custom utilities +* a command line script to handle database upgrade process + + +.. toctree:: + :maxdepth: 2 + + zodb + install + zca + site + traverser + tales + utilities + + +PyAMS applications architecture +------------------------------- + +PyAMS applications are built on a small set of prerequisites and components which *can* or, for some of them, *must* +be included. Some of them are: + +* a mandatory shared ZODB; + +* a websockets server, used to handle desktop notifications; you can find information about this component in the + :ref:`pyams_notify` chapter; + +* a Redis or Memcached server, to handle cache and sessions; + +* an Elasticsearch index, used to handle quick and optimized searching. + + +PyAMS external packages +----------------------- + +PyAMS is built on many external packages, and provides a whole set of extensions. He re is a list of them: + +* pyams_template (:ref:`pyams_template`) + +* pyams_viewlet (:ref:`pyams_viewlet`) + +* pyams_pagelet (:ref:`pyams_pagelet`) + +* pyams_utils (:ref:`pyams_utils`) + +* pyams_skin (:ref:`pyams_skin`) + +* pyams_form (:ref:`pyams_form`) + +* pyams_file (:ref:`pyams_file`) + +* pyams_i18n (:ref:`pyams_i18n`) + +* pyams_security (:ref:`pyams_security`) + +* pyams_zmi (:ref:`pyams_zmi`) + +* pyams_zodbbrowser (:ref:`pyams_zodbbrowser`) + +* pyams_catalog (:ref:`pyams_catalog`) + +* pyams_mail (:ref:`pyams_mail`) + +* pyams_ldap (:ref:`pyams_ldap`) + +* pyams_cache (:ref:`pyams_cache`) + +* pyams_alchemy (:ref:`pyams_alchemy`) + +* pyams_zmq (:ref:`pyams_zmq`) + +* pyams_scheduler (:ref:`pyams_scheduler`) + +* pyams_workflow (:ref:`pyams_workflow`) + +* pyams_thesaurus (:ref:`pyams_thesaurus`) + +* pyams_sequence (:ref:`pyams_sequence`) + +* pyams_portal (:ref:`pyams_portal`) + +* pyams_media (:ref:`pyams_media`) + +* pyams_notify (:ref:`pyams_notify`) + +* pyams_gis (:ref:`pyams_gis`) + +* pyams_content (:ref:`pyams_content`) + +* pyams_content_es (:ref:`pyams_content_es`) +œ + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modules` +* :ref:`modindex` +* :ref:`search`