Re: Good progress on replacing epydoc with Sphinx for API docs

--===============4603761372722809214==
Content-Type: multipart/alternative; boundary="f40304352914ff4c83055db03bf3"

--f40304352914ff4c83055db03bf3
Content-Type: text/plain; charset="UTF-8"

Hello,

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.

Regards,

Sourav

On Thu, Nov 2, 2017 at 2:55 AM, Peter Cock <[email protected]>
wrote:

> 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
> [email protected]
> http://mailman.open-bio.org/mailman/listinfo/biopython-dev
>

--f40304352914ff4c83055db03bf3
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">Hello,<div><br></div><div>Thanks for your effort in the do=
cumentation for Biopython.</div><div><br></div><div>Regarding the preferren=
ce 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 go=
od.</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 e=
ffort.</div><div><br></div><div>Regards,</div><div><br></div><div>Sourav</d=
iv></div><div class=3D"gmail_extra"><br><div class=3D"gmail_quote">On Thu, =
Nov 2, 2017 at 2:55 AM, Peter Cock <span dir=3D"ltr">&lt;<a href=3D"mailto:=
[email protected]" target=3D"_blank">[email protected]</a>&=
gt;</span> wrote:<br><blockquote class=3D"gmail_quote" style=3D"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=3D"https://github.com/biopython/biopython/issues/906" rel=3D"norefe=
rrer" target=3D"_blank">https://github.com/biopython/<wbr>biopython/issues/=
906</a><br>
<a href=3D"https://github.com/biopython/biopython/pull/1388" rel=3D"norefer=
rer" target=3D"_blank">https://github.com/biopython/<wbr>biopython/pull/138=
8</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&#39;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>
=C2=A0 the same time (at least in the short term, useful for<br>
=C2=A0 comparison and identifying any regressions).<br>
<br>
- Dropping epydoc, replacing its old HTML pages with<br>
=C2=A0 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=3D"http://biopython.org" rel=
=3D"noreferrer" target=3D"_blank">biopython.org</a><br>
(using GitHub Pages) versus using a third party site<br>
like <a href=3D"http://readthedocs.org" rel=3D"noreferrer" target=3D"_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=3D"mailto:[email protected]">Biopython-dev@mailman=
.open-<wbr>bio.org</a><br>
<a href=3D"http://mailman.open-bio.org/mailman/listinfo/biopython-dev" rel=
=3D"noreferrer" target=3D"_blank">http://mailman.open-bio.org/<wbr>mailman/=
listinfo/biopython-dev</a><br>
</blockquote></div><br></div>

--f40304352914ff4c83055db03bf3--

--===============4603761372722809214==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
Biopython-dev mailing list
[email protected]
http://mailman.open-bio.org/mailman/listinfo/biopython-dev
--===============4603761372722809214==--