diff options
| author | Georg Brandl <georg@python.org> | 2010-08-05 13:39:23 +0200 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-08-05 13:39:23 +0200 |
| commit | 6df4ce4445517da55db5dfba4f139d8d2cd591ae (patch) | |
| tree | 1172a7da36e6a8e4862e881d5bff10535676ee50 /doc/builders.rst | |
| parent | 50e8b6ac9e4bda6a1131fe34648259f0be807c0d (diff) | |
| download | sphinx-6df4ce4445517da55db5dfba4f139d8d2cd591ae.tar.gz | |
#481, #482: fix ``.name`` reference matching.
#482: When doing a non-exact search, match only the given type of object.
#481: Apply non-exact search for Python reference targets with ``.name`` for modules too.
Diffstat (limited to 'doc/builders.rst')
| -rw-r--r-- | doc/builders.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/builders.rst b/doc/builders.rst index 6e90ccc6..80203e75 100644 --- a/doc/builders.rst +++ b/doc/builders.rst @@ -255,11 +255,11 @@ All serialization builders outputs one file per source file and a few special files. They also copy the reST source files in the directory ``_sources`` under the output directory. -The :class:`PickleHTMLBuilder` is a builtin subclass that implements the pickle +The :class:`.PickleHTMLBuilder` is a builtin subclass that implements the pickle serialization interface. The files per source file have the extensions of -:attr:`~SerializingHTMLBuilder.out_suffix`, and are arranged in directories +:attr:`~.SerializingHTMLBuilder.out_suffix`, and are arranged in directories just as the source files are. They unserialize to a dictionary (or dictionary like structure) with these keys: @@ -290,7 +290,7 @@ like structure) with these keys: The special files are located in the root output directory. They are: -:attr:`SerializingHTMLBuilder.globalcontext_filename` +:attr:`.SerializingHTMLBuilder.globalcontext_filename` A pickled dict with these keys: ``project``, ``copyright``, ``release``, ``version`` @@ -309,7 +309,7 @@ The special files are located in the root output directory. They are: ``titles`` A dictionary of all documents' titles, as HTML strings. -:attr:`SerializingHTMLBuilder.searchindex_filename` +:attr:`.SerializingHTMLBuilder.searchindex_filename` An index that can be used for searching the documentation. It is a pickled list with these entries: |