Using websupport, how do I get the generated index?

[shimizukawa]

When building my project with "make html", genindex.html is generated as expected.

How do I get WebSupport to return the index? websupport.get_document("genindex") returns a dictionary, but d["body"] == "".

websupport = WebSupport(datadir="...", search="woosh")
document = websupport.get_document("genindex")

# document["body"] == ""

---

• Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/1003
• Originally reported by: Bernt R. Brenna
• Originally created at: 2012-09-11T11:39:50.842

[shimizukawa]

From Dustin Mitchell on 2014-11-25 18:12:11+00:00

This is actually not "minor" -- indexes of any sort do not work with WebSupport.

To reproduce:

• run sphinx-quickstart and accept defaults.
• put this in index.rst:

Welcome to Test's documentation!
================================

Contents:

.. py:module:: test.foo
.. py:class:: Bar

    .. py:method:: bar()

        foo the bar.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

put this in bug.py:

from sphinx.websupport import WebSupport

ws = WebSupport(
    srcdir='.',
    builddir='./bld')

ws.build()
print `ws.get_document('py-modindex')['body']`

Run bug.py:

Running Sphinx v1.2.3
loading pickled environment... done
building [websupport]: targets for 1 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
preparing documents... done
writing output... [100%] index                                                                                                      
writing additional files... genindex py-modindex search
copying static files... done
copying extra files... done
dumping object inventory... done
build succeeded.
''

that last '' indicates that the body of the document is empty.

I believe the culprit is somewhere in WebSupportBuilder._render_page, which assumes it's rendering page.html.

[shimizukawa]

moved to sphinx-doc/sphinxcontrib-websupport#11