diff options
Diffstat (limited to 'libbe')
| -rw-r--r-- | libbe/__init__.py | 24 | ||||
| -rw-r--r-- | libbe/bugdir.py | 2 | ||||
| -rw-r--r-- | libbe/command/serve_storage.py | 2 | ||||
| -rw-r--r-- | libbe/storage/__init__.py | 6 | ||||
| -rw-r--r-- | libbe/storage/http.py | 2 | ||||
| -rw-r--r-- | libbe/storage/util/properties.py | 2 | ||||
| -rw-r--r-- | libbe/storage/util/settings_object.py | 2 | ||||
| -rw-r--r-- | libbe/storage/vcs/base.py | 4 | ||||
| -rw-r--r-- | libbe/ui/util/user.py | 6 |
9 files changed, 25 insertions, 25 deletions
diff --git a/libbe/__init__.py b/libbe/__init__.py index a154007..efd744a 100644 --- a/libbe/__init__.py +++ b/libbe/__init__.py @@ -24,17 +24,17 @@ 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` +* :py:mod:`libbe.bugdir` +* :py:mod:`libbe.bug` +* :py:mod:`libbe.comment` +* :py:mod:`libbe.command` +* :py:mod:`libbe.diff` +* :py:mod:`libbe.error` +* :py:mod:`libbe.storage` +* :py:mod:`libbe.ui` +* :py:mod:`libbe.util` +* :py:mod:`libbe.version` +* :py:mod:`libbe._version` """ TESTING = False @@ -42,7 +42,7 @@ TESTING = False 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. +``TESTING=True`` before loading any :py:mod:`libbe` submodules. Examples -------- diff --git a/libbe/bugdir.py b/libbe/bugdir.py index 34c63c0..610badd 100644 --- a/libbe/bugdir.py +++ b/libbe/bugdir.py @@ -74,7 +74,7 @@ class BugDir (list, settings_object.SavedSettingsObject): Storage instance containing the bug directory. If `from_storage` is `False`, `storage` may be `None`. uuid : str, optional - Set the bugdir UUID (see :mod:`libbe.util.id`). + Set the bugdir UUID (see :py:mod:`libbe.util.id`). Useful if you are loading one of several bugdirs stored in a single Storage instance. from_storage : bool, optional diff --git a/libbe/command/serve_storage.py b/libbe/command/serve_storage.py index 641ec36..8d6f516 100644 --- a/libbe/command/serve_storage.py +++ b/libbe/command/serve_storage.py @@ -20,7 +20,7 @@ See Also -------- -:mod:`libbe.storage.http` : the associated client +:py:mod:`libbe.storage.http` : the associated client """ import logging diff --git a/libbe/storage/__init__.py b/libbe/storage/__init__.py index 0ed609d..9e26fa3 100644 --- a/libbe/storage/__init__.py +++ b/libbe/storage/__init__.py @@ -22,12 +22,12 @@ data. Also define assorted implementations for the Storage classes: -* :mod:`libbe.storage.vcs` -* :mod:`libbe.storage.http` +* :py:mod:`libbe.storage.vcs` +* :py:mod:`libbe.storage.http` Also define an assortment of storage-related tools and utilities: -* :mod:`libbe.storage.util` +* :py:mod:`libbe.storage.util` """ import base diff --git a/libbe/storage/http.py b/libbe/storage/http.py index 825e9f2..99912f3 100644 --- a/libbe/storage/http.py +++ b/libbe/storage/http.py @@ -21,7 +21,7 @@ implementation. See Also -------- -:mod:`libbe.command.serve_storage` : the associated server +:py:mod:`libbe.command.serve_storage` : the associated server """ from __future__ import absolute_import diff --git a/libbe/storage/util/properties.py b/libbe/storage/util/properties.py index fd10a48..f8d3767 100644 --- a/libbe/storage/util/properties.py +++ b/libbe/storage/util/properties.py @@ -34,7 +34,7 @@ more information on decorators. See Also -------- -:mod:`libbe.storage.util.settings_object` : bundle properties into a convenient package +:py:mod:`libbe.storage.util.settings_object` : bundle properties into a convenient package """ diff --git a/libbe/storage/util/settings_object.py b/libbe/storage/util/settings_object.py index 92b4d95..9e3ace5 100644 --- a/libbe/storage/util/settings_object.py +++ b/libbe/storage/util/settings_object.py @@ -23,7 +23,7 @@ based property storage. See Also -------- -:mod:`libbe.storage.util.properties` : underlying property definitions +:py:mod:`libbe.storage.util.properties` : underlying property definitions """ import libbe diff --git a/libbe/storage/vcs/base.py b/libbe/storage/vcs/base.py index 035c731..43d89cc 100644 --- a/libbe/storage/vcs/base.py +++ b/libbe/storage/vcs/base.py @@ -143,7 +143,7 @@ class CachedPathID (object): .../.be/BUGDIR/bugs/BUG/comments/COMMENT ^-- root path - See :mod:`libbe.util.id` for a discussion of ID formats. + See :py:mod:`libbe.util.id` for a discussion of ID formats. Examples -------- @@ -1069,7 +1069,7 @@ class VCS (libbe.storage.base.VersionedStorage): See Also -------- - :mod:`libbe.storage.util.upgrade` + :py:mod:`libbe.storage.util.upgrade` """ if path == None: path = os.path.join(self.repo, '.be', 'version') diff --git a/libbe/ui/util/user.py b/libbe/ui/util/user.py index 63d7d7f..386c187 100644 --- a/libbe/ui/util/user.py +++ b/libbe/ui/util/user.py @@ -19,11 +19,11 @@ """Tools for getting, setting, creating, and parsing the user's ID. IDs will look like 'John Doe <jdoe@example.com>'. Note that the -:mod:`libbe.storage.vcs.arch <Arch VCS backend>` *enforces* IDs with +:py:mod:`libbe.storage.vcs.arch <Arch VCS backend>` *enforces* IDs with this format. Do not confuse the user IDs discussed in this module, which refer to -humans, with the "user IDs" discussed in :mod:`libbe.util.id`, which +humans, with the "user IDs" discussed in :py:mod:`libbe.util.id`, which are human-readable tags refering to objects. """ @@ -129,7 +129,7 @@ def get_user_id(storage=None): 2. `storage.get_user_id`, if that function is defined. 3. :py:func:`get_fallback_username` and :py:func:`get_fallback_email`. - .. [#] See :mod:`libbe.storage.util.config`. + .. [#] See :py:mod:`libbe.storage.util.config`. Notes ----- |