summaryrefslogtreecommitdiff
path: root/doc/builders.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-01-17 19:21:04 +0100
committerGeorg Brandl <georg@python.org>2010-01-17 19:21:04 +0100
commitd640630d580aef603fed3e1dd6dfd15703a243f8 (patch)
tree0b66c66d6cb58b62a10c9cb661d46e81a8f69de0 /doc/builders.rst
parente3c024368288af42630cf3e5f838c2c977e71a98 (diff)
downloadsphinx-d640630d580aef603fed3e1dd6dfd15703a243f8.tar.gz
Fix some XXXes.
Diffstat (limited to 'doc/builders.rst')
-rw-r--r--doc/builders.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/builders.rst b/doc/builders.rst
index b543eb5f..4beb5bff 100644
--- a/doc/builders.rst
+++ b/doc/builders.rst
@@ -298,7 +298,9 @@ The special files are located in the root output directory. They are:
``environment.pickle``
The build environment. This is always a pickle file, independent of the
builder and a copy of the environment that was used when the builder was
- started. (XXX: document common members)
+ started.
- Unlike the other pickle files this pickle file requires that the sphinx
- module is available on unpickling.
+ .. todo:: Document common members.
+
+ Unlike the other pickle files this pickle file requires that the ``sphinx``
+ package is available on unpickling.