[Python-checkins] r62630 - in doctools/trunk: doc/config.rst sphinx/__init__.py

[georg.brandl]

Author: georg.brandl
Date: Fri May  2 11:05:30 2008
New Revision: 62630

Log:
Increase version number. Explain "fully qualified" in the config docs.


Modified:
   doctools/trunk/doc/config.rst
   doctools/trunk/sphinx/__init__.py

Modified: doctools/trunk/doc/config.rst
==============================================================================
--- doctools/trunk/doc/config.rst	(original)
+++ doctools/trunk/doc/config.rst	Fri May  2 11:05:30 2008
@@ -15,10 +15,14 @@
 and therefore can execute arbitrarily complex code.  Sphinx then reads simple
 names from the file's namespace as its configuration.
 
-Two conventions are important to keep in mind here: Relative paths are always
+Some conventions are important to keep in mind here: Relative paths are always
 used relative to the documentation root, and document names must always be given
 without file name extension.
 
+The term "fully-qualified name" refers to a string that names an importable
+Python object inside a module; for example, the FQN ``"sphinx.builder.Builder"``
+means the ``Builder`` class in the ``sphinx.builder`` module.
+
 The contents of the namespace are pickled (so that Sphinx can find out when
 configuration changes), so it may not contain unpickleable values -- delete them
 from the namespace with ``del`` if appropriate.  Modules are removed
@@ -130,16 +134,18 @@
 
    The style name to use for Pygments highlighting of source code.  Default is
    ``'sphinx'``, which is a builtin style designed to match Sphinx' default
-   style.  If it's a fully-qualified name of a custom Pygments style class this
-   is then used as custom style.
+   style.
+
+   .. versionchanged:: 0.2.1
+      If the value is a fully-qualified name of a custom Pygments style class,
+      this is then used as custom style.
 
 .. confval:: template_bridge
 
-   A string with the fully-qualified (that is, including the module name) name
-   of a callable (or simply a class) that returns an instance of
-   :class:`~sphinx.application.TemplateBridge`.  This instance is then used to
-   render HTML documents, and possibly the output of other builders (currently
-   the changes builder).
+   A string with the fully-qualified name of a callable (or simply a class) that
+   returns an instance of :class:`~sphinx.application.TemplateBridge`.  This
+   instance is then used to render HTML documents, and possibly the output of
+   other builders (currently the changes builder).
 
 
 .. _html-options:
@@ -244,10 +250,10 @@
 
 .. confval:: html_translator_class
 
-   A string with the fully-qualified (that is, including the module name) name
-   of a HTML Translator class, that is, a subclass of Sphinx'
-   :class:`~sphinx.htmlwriter.HTMLTranslator`, that is used to translate
-   document trees to HTML.  Default is ``None`` (use the builtin translator).
+   A string with the fully-qualified name of a HTML Translator class, that is, a
+   subclass of Sphinx' :class:`~sphinx.htmlwriter.HTMLTranslator`, that is used
+   to translate document trees to HTML.  Default is ``None`` (use the builtin
+   translator).
 
 .. confval:: htmlhelp_basename
 

Modified: doctools/trunk/sphinx/__init__.py
==============================================================================
--- doctools/trunk/sphinx/__init__.py	(original)
+++ doctools/trunk/sphinx/__init__.py	Fri May  2 11:05:30 2008
@@ -23,7 +23,7 @@
 from sphinx.util.console import darkred, nocolor
 
 __revision__ = '$Revision$'
-__version__ = '0.2'
+__version__ = '0.2.1'
 
 
 def usage(argv, msg=None):