docs/source/index.rst
changeset 125 985534bc6ab9
parent 124 53dc81f933ed
child 126 e2aeba0dd99c
equal deleted inserted replaced
124:53dc81f933ed 125:985534bc6ab9
     1 .. PyAMS_utils documentation master file, created by
       
     2    sphinx-quickstart on Tue Nov 15 16:18:42 2016.
       
     3    You can adapt this file completely to your liking, but it should at least
       
     4    contain the root `toctree` directive.
       
     5 
       
     6 .. _index:
       
     7 
       
     8 
       
     9 **WARNING**: this is a "work-in-progress" documentation. All elements described here are not publicly available yet!!!
       
    10 
       
    11 
       
    12 Welcome to PyAMS_utils's documentation!
       
    13 =======================================
       
    14 
       
    15 At first, PyAMS was "Pyramid Application Management Skin". Actually, it's not only a simple skin but a whole "Suite" of
       
    16 applications and content management tools.
       
    17 
       
    18 PyAMS_utils is a multipurpose utilities package, providing tools including:
       
    19 
       
    20  - custom interfaces
       
    21 
       
    22  - custom ZCA registry annotations
       
    23 
       
    24  - local registry support
       
    25 
       
    26  - network protocols utilities (for HTTP and XML-RPC)
       
    27 
       
    28  - custom utilities
       
    29 
       
    30  - a command line script to handle database upgrade process
       
    31 
       
    32 
       
    33 .. toctree::
       
    34    :maxdepth: 2
       
    35 
       
    36    install
       
    37    zeo
       
    38    zca
       
    39    site
       
    40    traverser
       
    41    tales
       
    42    utilities
       
    43 
       
    44 
       
    45 Indices and tables
       
    46 ------------------
       
    47 
       
    48 * :ref:`genindex`
       
    49 * :ref:`modules`
       
    50 * :ref:`modindex`
       
    51 * :ref:`search`