astropy/astropy — pull request #254 by eteq (2012-06-02 03:19:51+00:00)
Title: Fix doc build warnings

There were some miscellaneous docs that kept cropping up when building the docs that were bothering me: this fixes them. Some of them were when you have a situation like

```
..note ::
This is a note that breaks, but wants to reference the function
:func:`myfunc`. This confuses sphinx into thinking func is an
option for note.
```

There were also a few fixes from the developer documentation tidying, so @astrofrog, you may want to glance at those and make sure they're fine.

The only significant change was in `astropy.io.ascii.Cds`... an example in a docstring included a CDS-style table, and this includes a line that looks like ``======``, which confused sphinx into thinking it was supposed to be a header. I replaced one of the ``=`` with a space, which seems to fix it, but I admit it makes the example slightly inaccurate. @taldcroft, are you ok with this, or do you have some other fix in mind (note that this also broke the Cds docs page itself...)