<div dir="ltr">Hello,<div><br></div><div>Thanks for your effort in the documentation for Biopython.</div><div><br></div><div>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.</div><div><br></div><div>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.</div><div><br></div><div>Regards,</div><div><br></div><div>Sourav</div></div><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Nov 2, 2017 at 2:55 AM, Peter Cock <span dir="ltr"><<a href="mailto:p.j.a.cock@googlemail.com" target="_blank">p.j.a.cock@googlemail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Dear Biopythoneers,<br>
<br>
For those not subscribed to GitHub alerts, I wanted to mention<br>
I have made good progress on building the Biopython API<br>
documentation (drawing on our reStructuredText formatted<br>
docstrings) using sphinx-apidoc instead of epydoc. See:<br>
<br>
<a href="https://github.com/biopython/biopython/issues/906" rel="noreferrer" target="_blank">https://github.com/biopython/<wbr>biopython/issues/906</a><br>
<a href="https://github.com/biopython/biopython/pull/1388" rel="noreferrer" target="_blank">https://github.com/biopython/<wbr>biopython/pull/1388</a><br>
<br>
(The tool epydoc is no longer maintained, and the HTML<br>
it produces is quite old fashioned with no search support<br>
etc).<br>
<br>
I'm hoping we can use this for Biopython 1.71, our next<br>
release.<br>
<br>
Do people have any strong preference between:<br>
<br>
- Having both epydoc and sphinx versions online at<br>
  the same time (at least in the short term, useful for<br>
  comparison and identifying any regressions).<br>
<br>
- Dropping epydoc, replacing its old HTML pages with<br>
  redirects to sphinx equivalent pages.<br>
<br>
Also, do people have any strong preference between<br>
continuing to host the API docs under <a href="http://biopython.org" rel="noreferrer" target="_blank">biopython.org</a><br>
(using GitHub Pages) versus using a third party site<br>
like <a href="http://readthedocs.org" rel="noreferrer" target="_blank">readthedocs.org</a> (or both)?<br>
<br>
Either way, we can likely keep a copy of the docs for<br>
each Biopython release online for historical reference.<br>
<br>
Thanks,<br>
<br>
Peter<br>
______________________________<wbr>_________________<br>
Biopython-dev mailing list<br>
<a href="mailto:Biopython-dev@mailman.open-bio.org">Biopython-dev@mailman.open-<wbr>bio.org</a><br>
<a href="http://mailman.open-bio.org/mailman/listinfo/biopython-dev" rel="noreferrer" target="_blank">http://mailman.open-bio.org/<wbr>mailman/listinfo/biopython-dev</a><br>
</blockquote></div><br></div>