From c065f17c6a79ec52abc370c91f49e570798cf38e Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Fri, 26 Oct 2012 08:37:54 -0400 Subject: [PATCH] doc: update :class: to :py:class: for modern Sphinx. --- doc/hacking.txt | 20 ++++++++++---------- libbe/bug.py | 6 +++--- libbe/bugdir.py | 8 ++++---- libbe/command/serve_commands.py | 6 +++--- libbe/command/serve_storage.py | 6 +++--- libbe/comment.py | 4 ++-- libbe/diff.py | 2 +- libbe/storage/__init__.py | 4 ++-- libbe/storage/http.py | 4 ++-- libbe/storage/util/properties.py | 2 +- libbe/storage/util/settings_object.py | 6 +++--- libbe/storage/vcs/__init__.py | 16 ++++++++-------- libbe/storage/vcs/arch.py | 2 +- libbe/storage/vcs/base.py | 2 +- libbe/storage/vcs/bzr.py | 2 +- libbe/storage/vcs/darcs.py | 2 +- libbe/storage/vcs/git.py | 2 +- libbe/storage/vcs/hg.py | 2 +- libbe/storage/vcs/monotone.py | 2 +- libbe/util/id.py | 16 ++++++++-------- libbe/util/tree.py | 2 +- libbe/util/utility.py | 2 +- 22 files changed, 59 insertions(+), 59 deletions(-) diff --git a/doc/hacking.txt b/doc/hacking.txt index 1a42fa5..d81d7c8 100644 --- a/doc/hacking.txt +++ b/doc/hacking.txt @@ -11,13 +11,13 @@ 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 :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`, -:class:`~libbe.command.base.InputOutput`, -:class:`~libbe.command.base.StorageCallbacks`, and -:class:`~libbe.command.base.UserInterface`. You'll be subclassing -:class:`~libbe.command.base.Command` for your command, but all those +classes :py:class:`~libbe.command.base.Option`, +:py:class:`~libbe.command.base.Argument`, +:py:class:`~libbe.command.base.Command`, +:py:class:`~libbe.command.base.InputOutput`, +:py:class:`~libbe.command.base.StorageCallbacks`, and +:py:class:`~libbe.command.base.UserInterface`. You'll be subclassing +:py:class:`~libbe.command.base.Command` for your command, but all those classes will be important. @@ -26,12 +26,12 @@ Command completion BE implements a general framework to make it easy to support command completion for arbitrary plugins. In order to support this system, -any of your completable :class:`~libbe.command.base.Argument` +any of your completable :py: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 :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 +example of extensions via :py:class:`libbe.command.util.Completer`, or write a custom completion function from scratch. @@ -40,7 +40,7 @@ Adding user interfaces 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 +:py:class:`~libbe.command.base.UserInterface` instance for running commands. More details to come after I write an HTML UI... diff --git a/libbe/bug.py b/libbe/bug.py index c9b2acd..c16fedc 100644 --- a/libbe/bug.py +++ b/libbe/bug.py @@ -21,7 +21,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define the :class:`Bug` class for representing bugs. +"""Define the :py:class:`Bug` class for representing bugs. """ import copy @@ -122,9 +122,9 @@ load_status(active_status_def, inactive_status_def) class Bug (settings_object.SavedSettingsObject): """A bug (or issue) is a place to store attributes and attach - :class:`~libbe.comment.Comment`\s. In mailing-list terms, a bug is + :py:class:`~libbe.comment.Comment`\s. In mailing-list terms, a bug is analogous to a thread. Bugs are normally stored in - :class:`~libbe.bugdir.BugDir`\s. + :py:class:`~libbe.bugdir.BugDir`\s. >>> b = Bug() >>> print b.status diff --git a/libbe/bugdir.py b/libbe/bugdir.py index 610badd..fde4c32 100644 --- a/libbe/bugdir.py +++ b/libbe/bugdir.py @@ -20,7 +20,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define the :class:`BugDir` class for storing a collection of bugs. +"""Define the :py:class:`BugDir` class for storing a collection of bugs. """ import copy @@ -65,12 +65,12 @@ class NoBugMatches(libbe.util.id.NoIDMatches): class BugDir (list, settings_object.SavedSettingsObject): - """A BugDir is a container for :class:`~libbe.bug.Bug`\s, with some + """A BugDir is a container for :py:class:`~libbe.bug.Bug`\s, with some additional attributes. Parameters ---------- - storage : :class:`~libbe.storage.base.Storage` + storage : :py:class:`~libbe.storage.base.Storage` Storage instance containing the bug directory. If `from_storage` is `False`, `storage` may be `None`. uuid : str, optional @@ -83,7 +83,7 @@ class BugDir (list, settings_object.SavedSettingsObject): See Also -------- - :class:`SimpleBugDir` for some bugdir manipulation exampes. + :py:class:`SimpleBugDir` for some bugdir manipulation exampes. """ settings_properties = [] diff --git a/libbe/command/serve_commands.py b/libbe/command/serve_commands.py index b94faf1..4628bfb 100644 --- a/libbe/command/serve_commands.py +++ b/libbe/command/serve_commands.py @@ -16,7 +16,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define the :class:`ServeCommands` serving BE Commands over HTTP. +"""Define the :py:class:`ServeCommands` serving BE Commands over HTTP. See Also -------- @@ -160,8 +160,8 @@ class ServeCommands (libbe.util.wsgi.ServerCommand): This allows you to run local `be` commands interfacing with remote data, transmitting command requests over the network. - :class:`~libbe.command.base.Command` wrapper around - :class:`ServerApp`. + :py:class:`~libbe.command.base.Command` wrapper around + :py:class:`ServerApp`. """ name = 'serve-commands' diff --git a/libbe/command/serve_storage.py b/libbe/command/serve_storage.py index 8d6f516..57bea20 100644 --- a/libbe/command/serve_storage.py +++ b/libbe/command/serve_storage.py @@ -16,7 +16,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define the :class:`Serve` serving BE Storage over HTTP. +"""Define the :py:class:`Serve` serving BE Storage over HTTP. See Also -------- @@ -284,8 +284,8 @@ class ServeStorage (libbe.util.wsgi.ServerCommand): This allows you to run local `be` commands interfacing with remote data, transmitting file reads/writes/etc. over the network. - :class:`~libbe.command.base.Command` wrapper around - :class:`ServerApp`. + :py:class:`~libbe.command.base.Command` wrapper around + :py:class:`ServerApp`. """ name = 'serve-storage' diff --git a/libbe/comment.py b/libbe/comment.py index cdcb694..52c3250 100644 --- a/libbe/comment.py +++ b/libbe/comment.py @@ -19,7 +19,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define the :class:`Comment` class for representing bug comments. +"""Define the :py:class:`Comment` class for representing bug comments. """ import base64 @@ -93,7 +93,7 @@ def save_comments(bug): class Comment (Tree, settings_object.SavedSettingsObject): - """Comments are a notes that attach to :class:`~libbe.bug.Bug`\s in + """Comments are a notes that attach to :py:class:`~libbe.bug.Bug`\s in threaded trees. In mailing-list terms, a comment is analogous to a single part of an email. diff --git a/libbe/diff.py b/libbe/diff.py index 215f1f5..14f985e 100644 --- a/libbe/diff.py +++ b/libbe/diff.py @@ -18,7 +18,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Tools for comparing two :class:`libbe.bug.BugDir`\s. +"""Tools for comparing two :py:class:`libbe.bug.BugDir`\s. """ import difflib diff --git a/libbe/storage/__init__.py b/libbe/storage/__init__.py index 9e26fa3..991859a 100644 --- a/libbe/storage/__init__.py +++ b/libbe/storage/__init__.py @@ -16,8 +16,8 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define the :class:`~libbe.storage.base.Storage` and -:class:`~libbe.storage.base.VersionedStorage` classes for storing BE +"""Define the :py:class:`~libbe.storage.base.Storage` and +:py:class:`~libbe.storage.base.VersionedStorage` classes for storing BE data. Also define assorted implementations for the Storage classes: diff --git a/libbe/storage/http.py b/libbe/storage/http.py index 99912f3..030349d 100644 --- a/libbe/storage/http.py +++ b/libbe/storage/http.py @@ -16,7 +16,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define an HTTP-based :class:`~libbe.storage.base.VersionedStorage` +"""Define an HTTP-based :py:class:`~libbe.storage.base.VersionedStorage` implementation. See Also @@ -50,7 +50,7 @@ if TESTING == True: class HTTP (base.VersionedStorage): - """:class:`~libbe.storage.base.VersionedStorage` implementation over + """:py:class:`~libbe.storage.base.VersionedStorage` implementation over HTTP. Uses GET to retrieve information and POST to set information. diff --git a/libbe/storage/util/properties.py b/libbe/storage/util/properties.py index f8d3767..77c0162 100644 --- a/libbe/storage/util/properties.py +++ b/libbe/storage/util/properties.py @@ -364,7 +364,7 @@ def change_hook_property(hook, mutable=False, default=None): t.x.append(5) # external modification t.x # dummy access notices change and triggers hook - See :class:`testChangeHookMutableProperty` for an example of the + See :py:class:`testChangeHookMutableProperty` for an example of the expected behavior. Parameters diff --git a/libbe/storage/util/settings_object.py b/libbe/storage/util/settings_object.py index 9e3ace5..819698f 100644 --- a/libbe/storage/util/settings_object.py +++ b/libbe/storage/util/settings_object.py @@ -18,7 +18,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Provides :class:`SavedSettingsObject` implementing settings-dict +"""Provides :py:class:`SavedSettingsObject` implementing settings-dict based property storage. See Also @@ -198,8 +198,8 @@ class SavedSettingsObject(object): properties. This is useful for BE objects with saved properties - (e.g. :class:`~libbe.bugdir.BugDir`, :class:`~libbe.bug.Bug`, - :class:`~libbe.comment.Comment`). For example usage, consider the + (e.g. :py:class:`~libbe.bugdir.BugDir`, :py:class:`~libbe.bug.Bug`, + :py:class:`~libbe.comment.Comment`). For example usage, consider the unittests at the end of the module. See Also diff --git a/libbe/storage/vcs/__init__.py b/libbe/storage/vcs/__init__.py index c6f17f0..9dadd73 100644 --- a/libbe/storage/vcs/__init__.py +++ b/libbe/storage/vcs/__init__.py @@ -17,17 +17,17 @@ # Bugs Everywhere. If not, see . """Define the Version Controlled System (VCS)-based -:class:`~libbe.storage.base.Storage` and -:class:`~libbe.storage.base.VersionedStorage` implementations. +:py:class:`~libbe.storage.base.Storage` and +:py:class:`~libbe.storage.base.VersionedStorage` implementations. -There is a base class (:class:`~libbe.storage.vcs.VCS`) translating +There is a base class (:py:class:`~libbe.storage.vcs.VCS`) translating Storage language to VCS language, and a number of `VCS` implementations: -* :class:`~libbe.storage.vcs.arch.Arch` -* :class:`~libbe.storage.vcs.bzr.Bzr` -* :class:`~libbe.storage.vcs.darcs.Darcs` -* :class:`~libbe.storage.vcs.git.Git` -* :class:`~libbe.storage.vcs.hg.Hg` +* :py:class:`~libbe.storage.vcs.arch.Arch` +* :py:class:`~libbe.storage.vcs.bzr.Bzr` +* :py:class:`~libbe.storage.vcs.darcs.Darcs` +* :py:class:`~libbe.storage.vcs.git.Git` +* :py:class:`~libbe.storage.vcs.hg.Hg` The base `VCS` class also serves as a filesystem Storage backend (not versioning) in the event that a user has no VCS installed. diff --git a/libbe/storage/vcs/arch.py b/libbe/storage/vcs/arch.py index 117a121..9874345 100644 --- a/libbe/storage/vcs/arch.py +++ b/libbe/storage/vcs/arch.py @@ -59,7 +59,7 @@ def new(): return Arch() class Arch(base.VCS): - """:class:`base.VCS` implementation for GNU Arch. + """:py:class:`base.VCS` implementation for GNU Arch. """ name = 'arch' client = client diff --git a/libbe/storage/vcs/base.py b/libbe/storage/vcs/base.py index cf02306..9de2fe3 100644 --- a/libbe/storage/vcs/base.py +++ b/libbe/storage/vcs/base.py @@ -20,7 +20,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define the base :class:`VCS` (Version Control System) class, which +"""Define the base :py:class:`VCS` (Version Control System) class, which should be subclassed by other Version Control System backends. The base class implements a "do not version" VCS. """ diff --git a/libbe/storage/vcs/bzr.py b/libbe/storage/vcs/bzr.py index f449779..0c92058 100644 --- a/libbe/storage/vcs/bzr.py +++ b/libbe/storage/vcs/bzr.py @@ -54,7 +54,7 @@ def new(): return Bzr() class Bzr(base.VCS): - """:class:`base.VCS` implementation for Bazaar. + """:py:class:`base.VCS` implementation for Bazaar. """ name = 'bzr' client = None # bzrlib module diff --git a/libbe/storage/vcs/darcs.py b/libbe/storage/vcs/darcs.py index ad36cea..ec100b4 100644 --- a/libbe/storage/vcs/darcs.py +++ b/libbe/storage/vcs/darcs.py @@ -48,7 +48,7 @@ def new(): return Darcs() class Darcs(base.VCS): - """:class:`base.VCS` implementation for Darcs. + """:py:class:`base.VCS` implementation for Darcs. """ name='darcs' client='darcs' diff --git a/libbe/storage/vcs/git.py b/libbe/storage/vcs/git.py index b3276d5..7cf4652 100644 --- a/libbe/storage/vcs/git.py +++ b/libbe/storage/vcs/git.py @@ -278,7 +278,7 @@ class PygitGit(base.VCS): class ExecGit (PygitGit): - """:class:`base.VCS` implementation for Git. + """:py:class:`base.VCS` implementation for Git. """ name='git' client='git' diff --git a/libbe/storage/vcs/hg.py b/libbe/storage/vcs/hg.py index 8ca31c3..f2976ff 100644 --- a/libbe/storage/vcs/hg.py +++ b/libbe/storage/vcs/hg.py @@ -63,7 +63,7 @@ def new(): return Hg() class Hg(base.VCS): - """:class:`base.VCS` implementation for Mercurial. + """:py:class:`base.VCS` implementation for Mercurial. """ name='hg' client=None # mercurial module diff --git a/libbe/storage/vcs/monotone.py b/libbe/storage/vcs/monotone.py index 5dbc92b..abd3142 100644 --- a/libbe/storage/vcs/monotone.py +++ b/libbe/storage/vcs/monotone.py @@ -42,7 +42,7 @@ def new(): return Monotone() class Monotone (base.VCS): - """:class:`base.VCS` implementation for Monotone. + """:py:class:`base.VCS` implementation for Monotone. """ name='monotone' client='mtn' diff --git a/libbe/util/id.py b/libbe/util/id.py index 12f5e7b..8c34303 100644 --- a/libbe/util/id.py +++ b/libbe/util/id.py @@ -294,7 +294,7 @@ class ID (object): Parameters ---------- - object : :class:`~libbe.bugdir.BugDir` or :class:`~libbe.bug.Bug` or :class:`~libbe.comment.Comment` + object : :py:class:`~libbe.bugdir.BugDir` or :py:class:`~libbe.bug.Bug` or :py:class:`~libbe.comment.Comment` The object that the ID applies to. type : 'bugdir' or 'bug' or 'comment' The type of the object. @@ -389,7 +389,7 @@ def child_uuids(child_storage_ids): This is useful for separating data belonging to a particular object directly from entries for its child objects. Since the - :class:`~libbe.storage.base.Storage` backend doesn't distinguish + :py:class:`~libbe.storage.base.Storage` backend doesn't distinguish between the two. Examples @@ -404,7 +404,7 @@ def child_uuids(child_storage_ids): yield fields[0] def long_to_short_user(bugdirs, id): - """Convert a long user ID to a short user ID (see :class:`ID`). + """Convert a long user ID to a short user ID (see :py:class:`ID`). The list of bugdirs allows uniqueness-maintaining truncation of the bugdir portion of the ID. @@ -432,7 +432,7 @@ def long_to_short_user(bugdirs, id): return _assemble(ids) def short_to_long_user(bugdirs, id): - """Convert a short user ID to a long user ID (see :class:`ID`). The + """Convert a short user ID to a long user ID (see :py:class:`ID`). The list of bugdirs allows uniqueness-checking during expansion of the bugdir portion of the ID. @@ -494,7 +494,7 @@ class IDreplacer (object): return replacement def short_to_long_text(bugdirs, text): - """Convert short user IDs to long user IDs in text (see :class:`ID`). + """Convert short user IDs to long user IDs in text (see :py:class:`ID`). The list of bugdirs allows uniqueness-checking during expansion of the bugdir portion of the ID. @@ -507,7 +507,7 @@ def short_to_long_text(bugdirs, text): REGEXP, IDreplacer(bugdirs, short_to_long_user, strict=False), text) def long_to_short_text(bugdirs, text): - """Convert long user IDs to short user IDs in text (see :class:`ID`). + """Convert long user IDs to short user IDs in text (see :py:class:`ID`). The list of bugdirs allows uniqueness-maintaining truncation of the bugdir portion of the ID. @@ -542,7 +542,7 @@ def residual(base, fragment): return ('/'.join(root_ids), '/'.join(residual_ids)) def _parse_user(id): - """Parse a user ID (see :class:`ID`), returning a dict of parsed + """Parse a user ID (see :py:class:`ID`), returning a dict of parsed information. The returned dict will contain a value for "type" (from @@ -585,7 +585,7 @@ def _parse_user(id): return ret def parse_user(bugdirs, id): - """Parse a user ID (see :class:`ID`), returning a dict of parsed + """Parse a user ID (see :py:class:`ID`), returning a dict of parsed information. The returned dict will contain a value for "type" (from diff --git a/libbe/util/tree.py b/libbe/util/tree.py index 163c09a..affdb85 100644 --- a/libbe/util/tree.py +++ b/libbe/util/tree.py @@ -18,7 +18,7 @@ # You should have received a copy of the GNU General Public License along with # Bugs Everywhere. If not, see . -"""Define :class:`Tree`, a traversable tree structure. +"""Define :py:class:`Tree`, a traversable tree structure. """ import libbe diff --git a/libbe/util/utility.py b/libbe/util/utility.py index ecebfb0..b259768 100644 --- a/libbe/util/utility.py +++ b/libbe/util/utility.py @@ -45,7 +45,7 @@ class InvalidXML(ValueError): ---------- type : str String identifying `*`, e.g. "bug", "comment", ... - element : :class:`ElementTree.Element` + element : :py:class:`ElementTree.Element` ElementTree.Element instance which caused the error. error : str Error description. -- 2.26.2