docs/README.txt
branchdev-tf
changeset 421 ec94b4026195
parent 292 b338586588ad
child 439 d2a70e493aa8
equal deleted inserted replaced
420:b881e57cf6a5 421:ec94b4026195
     1 ===================
     1 ===================
     2 pyams_utils package
     2 PyAMS_utils package
     3 ===================
     3 ===================
     4 
     4 
     5 .. contents::
     5 .. contents::
     6 
     6 
     7 
     7 
     8 What is pyams_utils ?
     8 What is PyAMS
       
     9 =============
       
    10 
       
    11 PyAMS (Pyramid Application Management Suite) is a small suite of packages written for applications
       
    12 and content management with the Pyramid framework.
       
    13 
       
    14 **PyAMS** is actually mainly used to manage web sites through content management applications (CMS,
       
    15 see PyAMS_content package), but many features are generic and can be used inside any kind of web
       
    16 application.
       
    17 
       
    18 
       
    19 What is PyAMS_utils ?
     9 =====================
    20 =====================
    10 
    21 
    11 pyams_utils is a set of classes and functions which can be used to provide many small services and
    22 PyAMS_utils is a set of classes and functions which can be used to provide many small services and
    12 handle common operations in the context of a Pyramid application.
    23 handle common operations in the context of a Pyramid application.
    13 
    24 
    14 Internal sub-packages include:
    25 Internal sub-packages include:
    15  - registry: local registry management tools
    26  - registry: local registry management tools
    16  - adapter: custom adapters and annotations
    27  - adapter: custom adapters and annotations
    28 
    39 
    29 
    40 
    30 How to use pyams_utils ?
    41 How to use pyams_utils ?
    31 ========================
    42 ========================
    32 
    43 
    33 A set of pyams_utils usages are given as doctests in pyams_utils/doctests/README.txt
    44 A whole set of PyAMS documentation is available on `ReadTheDocs <https://pyams.readthedocs.io>`_
    34 
       
    35 You will also a whole set of documentations into the "docs" directory, available on
       
    36 `ReadTheDocs <http://pyams-utils.readthedocs.org>`_