[llvm-commits] Refactor Sphinx homepage

[Sean Silva]

This is a first step towards structuring the Sphinx docs better to make
them easier to browse and use. It doesn't change the structure or contents
of the docs at all.

In a future patch, I'm planning on taking each of

   design_and_overview.rst
   userguides.rst
   programming.rst
   subsystems.rst
   development_process.rst
   mailing_lists.rst

and reintegrating them into the homepage. This will be similar to how the
old html docs homepage was, so it will be familiar (and super-fast to
search with Ctrl-f, which I've seen at least one other person miss). The
current setup is just really bulky and hard to navigate, being on different
pages, when there's really not that much there, certainly not enough to
merit splitting up.

Another thing, but an important one, is that the way the current docs are
laid out in the reST source makes the end result incredibly ugly. For
example, the lists are indented by a space or two in the .rst file, which
causes Sphinx to emit a list of indented bullets, even though the bullets
are logically at the top level. Also, semantically, they should be
definition lists, not bulleted lists.

I'll be fixing all of these things once I get my feet wet with this patch.

Feedback on which direction to take the docs after that would be
appreciated.

--Sean Silva
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20120609/9a1e9855/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 1-sphinxdocs.patch
Type: application/octet-stream
Size: 2750 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20120609/9a1e9855/attachment.obj>