src/source/reference_guide/package_layout.rst
branchdoc-dc
changeset 109 31b3d00edb8a
parent 104 942151432421
equal deleted inserted replaced
108:1de74ac0628f 109:31b3d00edb8a
       
     1 .. _package_layout:
       
     2 
       
     3 PyAMS Package directory layout
       
     4 ------------------------------
       
     5 
       
     6 .. code-block:: bash
       
     7 
       
     8 
       
     9     ├── pyams_<package>/
       
    10     │   ├── doctests/       <- Documentation for the package
       
    11     |   ├── generation/     <- ZODB Migration directives
       
    12     │   ├── interfaces/     <- Interfaces definition
       
    13     │   ├── locales/        <- Store source code translation files (.mo .pot)
       
    14     │   ├── tests/          <- Contains python scripts for running tests including test runners, unit test
       
    15     │   ├── zmi/            <- ZMI subpackage to register and define elements in admin interface
       
    16     │   ├── __init__.py
       
    17     │   ├── include.py      <- Register Pyramid directives
       
    18     │   ├── configure.zcml  <- Overload default Zope config directive (optional)
       
    19     :   :.. <module>.py     <- source code
       
    20     :   :
       
    21     │   └── site.py
       
    22 
       
    23     ...