doc: update :mod: to :py:mod: for modern Sphinx.

diff --git a/doc/generate-libbe-txt.py b/doc/generate-libbe-txt.py
index 1da09b3718b61c6cc296d197572717fbb15d1edb..46ad2d171bbbafc71148972b812fed7e3b640269 100644 (file)
--- a/doc/generate-libbe-txt.py
+++ b/doc/generate-libbe-txt.py
@@ -28,7 +28,7 @@ sys.path.insert(0, os.path.abspath('..'))
 from test import python_tree
 
 def title(modname):
-    t = ':mod:`%s`' % modname
+    t = ':py:mod:`%s`' % modname
     delim = '*'*len(t)
     return '\n'.join([delim, t, delim, '', ''])
 

diff --git a/doc/hacking.txt b/doc/hacking.txt
index 2684597a5ee12b5d2c292e0dcc6e1326b2da3461..1a42fa5f9457f8eecfad78b681a6ba98214d7fc1 100644 (file)
--- a/doc/hacking.txt
+++ b/doc/hacking.txt
@@ -7,10 +7,10 @@ Adding commands
 
 To write a plugin, you simply create a new file in the
 :file:`libbe/command/` directory.  Take a look at one of the simpler
-plugins (e.g. :mod:`libbe.command.remove`) for an example of how that
+plugins (e.g. :py:mod:`libbe.command.remove`) for an example of how that
 looks, and to start getting a feel for the libbe interface.
 
-See :mod:`libbe.command.base` for the definition of the important
+See :py:mod:`libbe.command.base` for the definition of the important
 classes :class:`~libbe.command.base.Option`,
 :class:`~libbe.command.base.Argument`,
 :class:`~libbe.command.base.Command`,
@@ -29,8 +29,8 @@ completion for arbitrary plugins.  In order to support this system,
 any of your completable :class:`~libbe.command.base.Argument`
 instances (in your command's ``.options`` or ``.args``) should be
 initialized with some valid completion_callback function.  Some common
-cases are defined in :mod:`libbe.command.util`.  If you need more
-flexibility, see :mod:`libbe.command.list`\'s ``--sort`` option for an
+cases are defined in :py:mod:`libbe.command.util`.  If you need more
+flexibility, see :py:mod:`libbe.command.list`\'s ``--sort`` option for an
 example of extensions via :class:`libbe.command.util.Completer`, or
 write a custom completion function from scratch.
 
@@ -38,7 +38,7 @@ write a custom completion function from scratch.
 Adding user interfaces
 ======================
 
-Take a look at :mod:`libbe.ui.command_line` for an example.
+Take a look at :py:mod:`libbe.ui.command_line` for an example.
 Basically you'll need to setup a
 :class:`~libbe.command.base.UserInterface` instance for running
 commands.  More details to come after I write an HTML UI...

diff --git a/doc/http.txt b/doc/http.txt
index 345f4f0f04cea611e301c0a5451185848cac6d3f..f155a89d635237ae4233bafeadbfbb6aa043433a 100644 (file)
--- a/doc/http.txt
+++ b/doc/http.txt
@@ -9,5 +9,5 @@ You can run it from the BE source directory with::
 
     $ python interfaces/web/cfbe.py PATH_TO_REPO
 
-Eventually we'll move it into :mod:`libbe.ui` so it will be installed
+Eventually we'll move it into :py:mod:`libbe.ui` so it will be installed
 automatically with every BE installation.

diff --git a/doc/install.txt b/doc/install.txt
index 9895f84b665698adc27c9749782ec053f25f6cc3..b95eca741fd54747ea12597077b15285101673eb 100644 (file)
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -66,7 +66,7 @@ need to run::
 
     $ make
 
-to build some auto-generated files (e.g. :mod:`libbe._version`), and::
+to build some auto-generated files (e.g. :py:mod:`libbe._version`), and::
 
     $ make install
 

diff --git a/doc/tutorial.txt b/doc/tutorial.txt
index 10ee49e473c49d8a7567c1592ab81e2230d611e9..5af6f333a146f02f78e02da146827ce187d31a36 100644 (file)
--- a/doc/tutorial.txt
+++ b/doc/tutorial.txt
@@ -15,7 +15,7 @@ and helps keep the bug repository in sync with the code.
 
 However, there are some differences compared to centralized
 bugtrackers.  Because bugs and comments can be created by several
-users in parallel, they have globally unique :mod:`IDs
+users in parallel, they have globally unique :py:mod:`IDs
 <libbe.util.id>` rather than numbers.  There is also a
 developer-friendly command-line_ interface to compliment the
 user-friendly :doc:`web </http>` and :doc:`email </email>` interfaces.
@@ -105,7 +105,7 @@ if you call it from a directory besides your project's root.
 Inside the ``.be`` directory (among other things) there will be a long
 UUID_ directory.  This is your bug directory.  The idea is that you
 could keep several bug directories in the same repository, using one
-to track bugs, another to track roadmap issues, etc.  See :mod:`IDs
+to track bugs, another to track roadmap issues, etc.  See :py:mod:`IDs
 <libbe.util.id>` for details.  For BE itself, the bug directory is
 ``bea86499-824e-4e77-b085-2d581fa9ccab``, which is why all the bug and
 comment IDs in this tutorial will start with ``bea/``.

diff --git a/libbe/__init__.py b/libbe/__init__.py
index a154007e9b08b862f6472f0330857b5d6db4c3d2..efd744a335009db20bd7e1194e3bed4c6d5d4b7d 100644 (file)
--- 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 34c63c0b23f9a5aad91568f5d5a7565049ad16da..610badde5a48dd54c59700ebad6edf4659c80825 100644 (file)
--- 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 641ec3616cce2dc09e521314c1d9ab5ee6642c13..8d6f516b78591c9758a397e928724b84d80d5507 100644 (file)
--- 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 0ed609d356e2b4b310cf49a56f28995349445907..9e26fa31a88879b05610eb0fc6a204c44813cd15 100644 (file)
--- 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 825e9f25e178a07ca4992656a0e374a6bba78701..99912f309c0be7fda1543647fa6a9be447912890 100644 (file)
--- 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 fd10a48ea6c6648907ecfac0217541dc335c1112..f8d376701b21ce4ccfe4aa777a1a04a571ebd38c 100644 (file)
--- 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 92b4d95eaa5b6df8631aef938e7304b777377836..9e3ace588270de28db834d7321e9760831a9a69a 100644 (file)
--- 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 035c731dd8c8cedf1c650bf4e99e5544f61ddc35..43d89ccabaeb0cac2ba4f31284e7a7016ec8f161 100644 (file)
--- 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 63d7d7f9e847f652971f21562caeb810067597a1..386c1879ad209a5ec9e300400256e1c0d5155f65 100644 (file)
--- 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
     -----