aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/generate-libbe-txt.py2
-rw-r--r--doc/hacking.txt10
-rw-r--r--doc/http.txt2
-rw-r--r--doc/install.txt2
-rw-r--r--doc/tutorial.txt4
5 files changed, 10 insertions, 10 deletions
diff --git a/doc/generate-libbe-txt.py b/doc/generate-libbe-txt.py
index 1da09b3..46ad2d1 100644
--- 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 2684597..1a42fa5 100644
--- 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 345f4f0..f155a89 100644
--- 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 9895f84..b95eca7 100644
--- 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 10ee49e..5af6f33 100644
--- 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/``.