# HG changeset patch # User Thierry Florac # Date 1479643134 -3600 # Node ID b183ee9e7ea14ed2f7d4bd5a75ecf1adcbae7fe4 # Parent 2908b4f3eb24fc06892da1b6a703212224a51cff Updated documentation diff -r 2908b4f3eb24 -r b183ee9e7ea1 docs/README.txt --- a/docs/README.txt Fri Nov 18 17:05:55 2016 +0100 +++ b/docs/README.txt Sun Nov 20 12:58:54 2016 +0100 @@ -4,27 +4,33 @@ .. contents:: + What is pyams_utils ? ===================== pyams_utils is a set of classes and functions which can be used to provide many small services and handle common operations in the context of a Pyramid application. -Internal sub-packages include : - - date : convert dates to unicode ISO format, parse ISO datetime, convert date to datetime - - request : get current request, get request annotations, get and set request data via annotations - - timezone : convert datetime to a given timezone ; provides a server default timezone utility - - traversing : get object parents until a given interface is implemented - - unicode : convert any text to unicode for easy storage - - protocol : utility functions and modules for several nerwork protocols - - catalog : TextIndexNG index for Zope catalog and hurry.query "Text" query item - - text : simple text operations and text to HTML conversion - - html : HTML parser and HTML to text converter - - file : file upload data converter - - tal : text and HTML conversions for use from within TAL +Internal sub-packages include: + - registry: local registry management tools + - adapter: custom adapters and annotations + - date: convert dates to unicode ISO format, parse ISO datetime, convert date to datetime + - request: get current request, get request annotations, get and set request data via annotations + - session: to store and get properties values from current session + - timezone: convert datetime to a given timezone ; provides a server default timezone utility + - traversing: custom traverser utility supporting namespaces + - unicode: convert any text to unicode for easy storage + - protocol: utility functions and modules for several nerwork protocols + - text: simple text operations and text to HTML conversion + - html: HTML parser and HTML to text converter + - file: file upload data converter + - tales: custom "extension:" TALES expression using adapters How to use pyams_utils ? ======================== A set of pyams_utils usages are given as doctests in pyams_utils/doctests/README.txt + +You will also a whole set of documentations into the "docs" directory, available on +`ReadTheDocs `_ diff -r 2908b4f3eb24 -r b183ee9e7ea1 docs/source/index.rst --- a/docs/source/index.rst Fri Nov 18 17:05:55 2016 +0100 +++ b/docs/source/index.rst Sun Nov 20 12:58:54 2016 +0100 @@ -12,7 +12,7 @@ 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 set of +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: