[Biopython-dev] Good progress on replacing epydoc with Sphinx for API docs

Sourav Singh ssouravsingh12 at gmail.com
Sat Nov 11 07:46:05 UTC 2017


Thanks for your effort in the documentation for Biopython.

Regarding the preferrence between epydoc and sphinx-apidoc, I prefer having
the epydoc and sphinx-doc for the 1.71 release and dropping epydoc later
once everything seems good.

As for the hosting of the docs, I am okay with both Github pages and
Readthedocs. I would suggest going with Github pages, since it is already
live and adding the API links should require little effort.



On Thu, Nov 2, 2017 at 2:55 AM, Peter Cock <p.j.a.cock at googlemail.com>

> Dear Biopythoneers,
> For those not subscribed to GitHub alerts, I wanted to mention
> I have made good progress on building the Biopython API
> documentation (drawing on our reStructuredText formatted
> docstrings) using sphinx-apidoc instead of epydoc. See:
> https://github.com/biopython/biopython/issues/906
> https://github.com/biopython/biopython/pull/1388
> (The tool epydoc is no longer maintained, and the HTML
> it produces is quite old fashioned with no search support
> etc).
> I'm hoping we can use this for Biopython 1.71, our next
> release.
> Do people have any strong preference between:
> - Having both epydoc and sphinx versions online at
>   the same time (at least in the short term, useful for
>   comparison and identifying any regressions).
> - Dropping epydoc, replacing its old HTML pages with
>   redirects to sphinx equivalent pages.
> Also, do people have any strong preference between
> continuing to host the API docs under biopython.org
> (using GitHub Pages) versus using a third party site
> like readthedocs.org (or both)?
> Either way, we can likely keep a copy of the docs for
> each Biopython release online for historical reference.
> Thanks,
> Peter
> _______________________________________________
> Biopython-dev mailing list
> Biopython-dev at mailman.open-bio.org
> http://mailman.open-bio.org/mailman/listinfo/biopython-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.open-bio.org/pipermail/biopython-dev/attachments/20171111/71ec692c/attachment.html>

More information about the Biopython-dev mailing list