added feedback
[docutils.git] / sandbox / grubert / directory_structur
blob44e39d4dff66c8ed60e9410955954a64a9af6a3f
1 Sandbox directory structure (2002-07-05)
3 sandbox/
4     userid/
5         component_name/ # A verbose name is best.
6             README.txt  # Please explain requirements,
7                         # purpose/goals, and usage.
8             docs/
9                 ...
10             component.py    # The component is a single module.
11                         # *OR* (but *not* both)
12             component/  # The component is a package.
13                 __init__.py  # Contains the Reader/Writer class.
14                 other1.py    # Other modules and data files used
15                 data.txt     # by this component.
16                 ...
17             test/       # Test suite.
18                 ...
19             tools/      # For front-ends etc.
20                 ...
21             setup.py    # Use Distutils to install the component
22                         # code and tools/ files into the right
23                         # places in Docutils.