Commits

Anonymous committed 967e224

added doc: config.rst, builders.rst

Comments (0)

Files changed (2)

 
    Its name is ``htmlhelp``.
 
+.. module:: sphinx.builders.eclipsehelp
+.. class:: EclipseHelpBuilder
+
+   This builder creates a help plugin for Eclipse-based applications. 
+   The plugin contains HTML files, stylesheets and a ``toc.xml`` which
+   describes the document structure, as well as the usual plugin metadata files.
+   
+
+   Its name is ``eclipsehelp``.
+
 .. module:: sphinx.builders.latex
 .. class:: LaTeXBuilder
 
 
    .. deprecated:: 0.5
       Use the ``'pointsize'`` key in the :confval:`latex_elements` value.
+
+.. _eclipsehelp-options:
+
+Options for Eclipse Help output
+-------------------------------
+
+.. confval:: eclipse_plugin_id
+
+   The plugin ID. It will be written into the ``Bundle-SymbolicName:`` line of the ``MANIFEST.MF``.
+
+.. confval:: eclipse_plugin_version
+
+   The plugin version. It will be written into the ``Bundle-Version:`` line of the ``MANIFEST.MF``.
+
+.. confval:: eclipse_plugin_nice_name
+
+   The human-readable name of the plugin. It will be written into the ``Bundle-Name:`` line of the ``MANIFEST.MF``.
+
+.. confval:: eclipse_plugin_provider_name
+
+   The human-readable name of the plugin's vendor. It will be written into the ``Bundle-Vendor:`` line of the ``MANIFEST.MF``. 
+
+.. confval:: eclipse_create_jar
+
+   If true, the builder will create a JAR file out of the plugin contents.
+
+.. confval:: eclipse_jar_name
+
+   If :confval:`eclipse_create_jar` is true, the JAR filename can be set using this option.
+
+