Some more fixes after the great renaming.

This commit is contained in:
Georg Brandl 2008-11-29 20:04:11 +01:00
parent 18d1581eec
commit bd12a8e547
8 changed files with 17 additions and 11 deletions

View File

@ -3,7 +3,7 @@
Available builders Available builders
================== ==================
.. module:: sphinx.builder .. module:: sphinx.builders
:synopsis: Available built-in builder classes. :synopsis: Available built-in builder classes.
These are the built-in Sphinx builders. More builders can be added by These are the built-in Sphinx builders. More builders can be added by
@ -13,6 +13,7 @@ The builder's "name" must be given to the **-b** command-line option of
:program:`sphinx-build` to select a builder. :program:`sphinx-build` to select a builder.
.. module:: sphinx.builders.html
.. class:: StandaloneHTMLBuilder .. class:: StandaloneHTMLBuilder
This is the standard HTML builder. Its output is a directory with HTML This is the standard HTML builder. Its output is a directory with HTML
@ -30,6 +31,7 @@ The builder's "name" must be given to the **-b** command-line option of
Its name is ``htmlhelp``. Its name is ``htmlhelp``.
.. module:: sphinx.builders.latex
.. class:: LaTeXBuilder .. class:: LaTeXBuilder
This builder produces a bunch of LaTeX files in the output directory. You This builder produces a bunch of LaTeX files in the output directory. You
@ -50,6 +52,7 @@ The builder's "name" must be given to the **-b** command-line option of
Its name is ``latex``. Its name is ``latex``.
.. module:: sphinx.builders.text
.. class:: TextBuilder .. class:: TextBuilder
This builder produces a text file for each reST file -- this is almost the This builder produces a text file for each reST file -- this is almost the
@ -60,6 +63,7 @@ The builder's "name" must be given to the **-b** command-line option of
.. versionadded:: 0.4 .. versionadded:: 0.4
.. currentmodule:: sphinx.builders.html
.. class:: SerializingHTMLBuilder .. class:: SerializingHTMLBuilder
This builder uses a module that implements the Python serialization API This builder uses a module that implements the Python serialization API
@ -135,6 +139,7 @@ The builder's "name" must be given to the **-b** command-line option of
.. versionadded:: 0.5 .. versionadded:: 0.5
.. module:: sphinx.builders.changes
.. class:: ChangesBuilder .. class:: ChangesBuilder
This builder produces an HTML overview of all :dir:`versionadded`, This builder produces an HTML overview of all :dir:`versionadded`,
@ -144,6 +149,7 @@ The builder's "name" must be given to the **-b** command-line option of
Its name is ``changes``. Its name is ``changes``.
.. module:: sphinx.builders.linkcheck
.. class:: CheckExternalLinksBuilder .. class:: CheckExternalLinksBuilder
This builder scans all documents for external links, tries to open them with This builder scans all documents for external links, tries to open them with

View File

@ -22,8 +22,8 @@ Important points to note:
* The term "fully-qualified name" refers to a string that names an importable * The term "fully-qualified name" refers to a string that names an importable
Python object inside a module; for example, the FQN Python object inside a module; for example, the FQN
``"sphinx.builder.Builder"`` means the ``Builder`` class in the ``"sphinx.builders.Builder"`` means the ``Builder`` class in the
``sphinx.builder`` module. ``sphinx.builders`` module.
* Remember that document names use ``/`` as the path separator and don't contain * Remember that document names use ``/`` as the path separator and don't contain
the file name extension. the file name extension.
@ -412,7 +412,7 @@ that use Sphinx' HTMLWriter class.
.. confval:: html_translator_class .. confval:: html_translator_class
A string with the fully-qualified name of a HTML Translator class, that is, a 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 subclass of Sphinx' :class:`~sphinx.writers.html.HTMLTranslator`, that is used
to translate document trees to HTML. Default is ``None`` (use the builtin to translate document trees to HTML. Default is ``None`` (use the builtin
translator). translator).

View File

@ -13,7 +13,7 @@ the following public API:
.. method:: Sphinx.add_builder(builder) .. method:: Sphinx.add_builder(builder)
Register a new builder. *builder* must be a class that inherits from Register a new builder. *builder* must be a class that inherits from
:class:`~sphinx.builder.Builder`. :class:`~sphinx.builders.Builder`.
.. method:: Sphinx.add_config_value(name, default, rebuild_env) .. method:: Sphinx.add_config_value(name, default, rebuild_env)

View File

@ -5,7 +5,7 @@ Writing new builders
.. todo:: Expand this. .. todo:: Expand this.
.. currentmodule:: sphinx.builder .. currentmodule:: sphinx.builders
.. class:: Builder .. class:: Builder

View File

@ -6,7 +6,7 @@ Glossary
.. glossary:: .. glossary::
builder builder
A class (inheriting from :class:`~sphinx.builder.Builder`) that takes A class (inheriting from :class:`~sphinx.builders.Builder`) that takes
parsed documents and performs an action on them. Normally, builders parsed documents and performs an action on them. Normally, builders
translate the documents to an output format, but it is also possible to translate the documents to an output format, but it is also possible to
use the builder builders that e.g. check for broken links in the use the builder builders that e.g. check for broken links in the

View File

@ -19,10 +19,10 @@ No. You have several other options:
configuration value accordingly. configuration value accordingly.
* You can :ref:`write a custom builder <writing-builders>` that derives from * You can :ref:`write a custom builder <writing-builders>` that derives from
:class:`~sphinx.builder.StandaloneHTMLBuilder` and calls your template engine :class:`~sphinx.builders.StandaloneHTMLBuilder` and calls your template engine
of choice. of choice.
* You can use the :class:`~sphinx.builder.PickleHTMLBuilder` that produces * You can use the :class:`~sphinx.builders.PickleHTMLBuilder` that produces
pickle files with the page contents, and postprocess them using a custom tool, pickle files with the page contents, and postprocess them using a custom tool,
or use them in your Web application. or use them in your Web application.

View File

@ -16,7 +16,7 @@ import inspect
import cPickle as pickle import cPickle as pickle
from os import path from os import path
from sphinx.builder import Builder from sphinx.builders import Builder
# utility # utility

View File

@ -21,7 +21,7 @@ doctest = __import__('doctest')
from docutils import nodes from docutils import nodes
from docutils.parsers.rst import directives from docutils.parsers.rst import directives
from sphinx.builder import Builder from sphinx.builders import Builder
from sphinx.util.console import bold from sphinx.util.console import bold
blankline_re = re.compile(r'^\s*<BLANKLINE>', re.MULTILINE) blankline_re = re.compile(r'^\s*<BLANKLINE>', re.MULTILINE)