src/source/package_layout.rst
branchdoc-dc
changeset 51 5ebe61e3a965
child 89 d018bfffa7ca
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/package_layout.rst	Fri Apr 27 11:51:08 2018 +0200
@@ -0,0 +1,20 @@
+PyAMS Package directory layout
+------------------------------
+
+.. code-block:: bash
+
+
+    ├── pyams_<package>/
+    │   ├── doctests/       <- Documentation for the package
+    │   ├── interfaces/     <- Interfaces definition
+    │   ├── locales/        <- Store source code translation files (.mo .pot)
+    │   ├── tests/          <- Contains python scripts for running tests including test runners, unit test
+    │   ├── zmi/            <- ZMI subpackage to register and define elements in admin interface
+    │   ├── __init__.py
+    │   ├── include.py      <- Register Pyramid directives
+    │   ├── configure.zcml  <- Overload default Zope config directive (optional)
+    :   :.. <module>.py     <- source code
+    :   :
+    │   └── site.py
+
+    ...