Make the concept of "module index" generalized to domains. As a side-effect, the latex modindex is no longer generated by LaTeX.

4 files changed, 41 insertions, 13 deletions

diff --git a/doc/builders.rst b/doc/builders.rst
index f609ab71..e72941fa 100644
--- a/doc/builders.rst
+++ b/doc/builders.rst
@@ -277,8 +277,8 @@ The special files are located in the root output directory.  They are:
    ``project``, ``copyright``, ``release``, ``version``
       The same values as given in the configuration file.
 
-   ``style``, ``use_modindex``
-      :confval:`html_style` and :confval:`html_use_modindex`, respectively.
+   ``style``
+      :confval:`html_style`.
 
    ``last_updated``
       Date of last build.
diff --git a/doc/concepts.rst b/doc/concepts.rst
index 6f7967cf..b0040d8f 100644
--- a/doc/concepts.rst
+++ b/doc/concepts.rst
@@ -162,8 +162,8 @@ The special document names (and pages generated for them) are:
 
 * ``genindex``, ``modindex``, ``search``
 
-  These are used for the general index, the module index, and the search page,
-  respectively.
+  These are used for the general index, the Python module index, and the search
+  page, respectively.
 
   The general index is populated with entries from modules, all index-generating
   :ref:`object descriptions <desc-units>`, and from :dir:`index` directives.
diff --git a/doc/config.rst b/doc/config.rst
index f17071b8..0793759a 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -208,10 +208,11 @@ General configuration
 
 .. confval:: modindex_common_prefix
 
-   A list of prefixes that are ignored for sorting the module index (e.g.,
-   if this is set to ``['foo.']``, then ``foo.bar`` is shown under ``B``, not
-   ``F``). This can be handy if you document a project that consists of a single
-   package.  Works only for the HTML builder currently.   Default is ``[]``.
+   A list of prefixes that are ignored for sorting the Python module index
+   (e.g., if this is set to ``['foo.']``, then ``foo.bar`` is shown under ``B``,
+   not ``F``). This can be handy if you document a project that consists of a
+   single package.  Works only for the HTML builder currently.  Default is
+   ``[]``.
 
    .. versionadded:: 0.6
 
@@ -528,10 +529,25 @@ that use Sphinx' HTMLWriter class.
          ... old template content ...
          {% endblock %}
 
+.. confval:: html_domain_indices
+
+   If true, generate domain-specific indices in addition to the general index.
+   For e.g. the Python domain, this is the global module index.  Default is
+   ``True``.
+
+   This value can be a bool or a list of index names that should be generated.
+   To find out the index name for a specific index, look at the HTML file name.
+   For example, the Python module index has the name ``'py-modindex'``.
+
+   .. versionadded:: 1.0
+
 .. confval:: html_use_modindex
 
    If true, add a module index to the HTML documents.   Default is ``True``.
 
+   .. deprecated:: 1.0
+      Use :confval:`html_domain_indices`.
+
 .. confval:: html_use_index
 
    If true, add an index to the HTML documents.  Default is ``True``.
@@ -769,10 +785,24 @@ These options influence LaTeX output.
 
    A list of document names to append as an appendix to all manuals.
 
+.. confval:: latex_domain_indices
+
+   If true, generate domain-specific indices in addition to the general index.
+   For e.g. the Python domain, this is the global module index.  Default is
+   ``True``.
+
+   This value can be a bool or a list of index names that should be generated,
+   like for :confval:`html_domain_indices`.
+
+   .. versionadded:: 1.0
+
 .. confval:: latex_use_modindex
 
    If true, add a module index to LaTeX documents.   Default is ``True``.
 
+   .. deprecated:: 1.0
+      Use :confval:`latex_domain_indices`.
+
 .. confval:: latex_elements
 
    .. versionadded:: 0.5
@@ -839,9 +869,7 @@ These options influence LaTeX output.
      ``'logo'``
      ``'releasename'``
      ``'makeindex'``
-     ``'makemodindex'``
      ``'shorthandoff'``
-     ``'printmodindex'``
 
 .. confval:: latex_docclass
 
diff --git a/doc/templating.rst b/doc/templating.rst
index 5793fc17..5bf09dbd 100644
--- a/doc/templating.rst
+++ b/doc/templating.rst
@@ -318,9 +318,9 @@ in the future.
 .. data:: rellinks
 
    A list of links to put at the left side of the relbar, next to "next" and
-   "prev".  This usually contains links to the index and the modindex.  If you
-   add something yourself, it must be a tuple ``(pagename, link title,
-   accesskey, link text)``.
+   "prev".  This usually contains links to the general index and other indices,
+   such as the Python module index.  If you add something yourself, it must be a
+   tuple ``(pagename, link title, accesskey, link text)``.
 
 .. data:: shorttitle