diff options
| author | W. Trevor King <wking@drexel.edu> | 2010-02-08 17:05:12 -0500 |
|---|---|---|
| committer | W. Trevor King <wking@drexel.edu> | 2010-02-08 17:05:12 -0500 |
| commit | 37d61e9ecd8768b25ba4aff3c657ccc56f086dd0 (patch) | |
| tree | 31214efb9536a319473277610534cf2f37215ed1 /libbe/__init__.py | |
| parent | 3f27c5c3bbc1ecd00db51c4894a9bf9651ae4fbb (diff) | |
| parent | 960565a8cc80f98d0a8bfa77029fbc78692ea1a1 (diff) | |
| download | bugseverywhere-37d61e9ecd8768b25ba4aff3c657ccc56f086dd0.tar.gz | |
Merged initial Sphinx documentation structure.
There's still a long way to go in this direction, but the basic
framework is now in place. Toss in numpydoc-style docstrings
http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
when you have time, and things will gradually improve over time.
I also punted our user ID creation/parsing in libbe.ui.util.user to
the email module. This way IDs are handled in an RFC-compliant way
(less suprising for users) and by someone else (less work for us :).
Diffstat (limited to 'libbe/__init__.py')
| -rw-r--r-- | libbe/__init__.py | 38 |
1 files changed, 35 insertions, 3 deletions
diff --git a/libbe/__init__.py b/libbe/__init__.py index 23acfef..d32716f 100644 --- a/libbe/__init__.py +++ b/libbe/__init__.py @@ -15,7 +15,39 @@ # with this program; if not, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -# To reduce module load time, test suite generation is turned of by -# default. If you _do_ want to generate the test suites, set -# TESTING=True before loading any libbe or becommands submodules. +"""The libbe module does all the legwork for bugs-everywhere_ (BE). + +.. _bugs-everywhere: http://bugseverywhere.org + +To facilitate faster loading, submodules are not imported by default. +The available submodules are: + +* :mod:`libbe.bugdir` +* :mod:`libbe.bug` +* :mod:`libbe.comment` +* :mod:`libbe.command` +* :mod:`libbe.diff` +* :mod:`libbe.error` +* :mod:`libbe.storage` +* :mod:`libbe.ui` +* :mod:`libbe.util` +* :mod:`libbe.version` +* :mod:`libbe._version` +""" + TESTING = False +"""Flag controlling test-suite generation. + +To reduce module load time, test suite generation is turned of by +default. If you *do* want to generate the test suites, set +``TESTING=True`` before loading any :mod:`libbe` submodules. + +Examples +-------- + +>>> import libbe +>>> libbe.TESTING = True +>>> import libbe.bugdir +>>> 'SimpleBugDir' in dir(libbe.bugdir) +True +""" |