[Biopython-dev] Documentation Status

[Peter Cock]

On Mon, Oct 13, 2014 at 6:02 PM, Travis Wrightsman <twrig002 at ucr.edu> wrote:
> Thank you for the introduction!
>
> It looks like the Align/Applications package is mostly in epydocs format.
> I'll see what work I can do to convert the docstrings into reStructuredText
> module by module or file by file.

Great.

> I will also see if I can install the Sphinx compiler on my linux server and
> test the output as I go along. Are both Sphinx and Epydocs compatible with
> both reStructuredText and epydocs format?

No. Sphinx does not understand the epydoc markup - at least, last time I
checked: http://blastedbio.blogspot.co.uk/2013/07/markup-support-for-python-project.html

However, epydoc understands several formats including its own markup
AND reStructuredText.

Peter