[Biopython-dev] Port Biopython documentation to Sphinx

[Kristian Rother]

Hi,

I've seen Sphinx being used on several projects (see e.g.
http://pycogent.sourceforge.net/cookbook/index.html) and tried it on one
myself (2009). The system for mixing text+code and testing code examples
is gorgeous!

What I didn't like is that all Sphinx sites seem to look the same
(including font sizes and colours). There probably is a place to apply a
CSS stylesheet, but it was not easy to find. There might be some work at
this point.

Is someone trying to make a proof-of-concept on GIT or are we looking for
a volunteer?

Best regards,
   Kristian



>
> Issue #3219 has been reported by Eric Talevich.
>
> ----------------------------------------
> Feature #3219: Port Biopython documentation to Sphinx
> https://redmine.open-bio.org/issues/3219
>
> Author: Eric Talevich
> Status: New
> Priority: Low
> Assignee: Biopython Dev Mailing List
> Category: Documentation
> Target version:
> URL:
>
>
> Currently we use Epydoc for the API reference documentation, and LaTeX (to
> PDF via pdflatex, and HTML via hevea) for the tutorial. There's some
> material on the wiki to consider, too.
>
> A number of Python projects, including CPython, now use Sphinx for
> documentation. Content is written in reStructuredText format, and can be
> pulled from both standalone .rst files and Python docstrings.
>
> This offers several advantages: (i) API documentation will be prettier and
> easier to navigate; (ii) the Tutorial will be easier to edit for those not
> fluent in LaTeX; (iii) Since the API reference and Tutorial will be
> written in the same markup, potentially even pulling from some shared
> sources, it will be easier to  address redundant or overlapping portions
> between the two, avoiding inconsistencies.
>
> See:
> http://sphinx.pocoo.org/
> http://docutils.sourceforge.net/
>
> Mailing list discussion:
> http://lists.open-bio.org/pipermail/biopython-dev/2010-July/007977.html
>
> Numpy's approach:
> http://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
>
>
>
> ----------------------------------------
> You have received this notification because this email was added to the
> New Issue Alert plugin
>
>
> --
> You have received this notification because you have either subscribed to
> it, or are involved in it.
> To change your notification preferences, please click here and login:
> http://redmine.open-bio.org
>
> _______________________________________________
> Biopython-dev mailing list
> Biopython-dev at lists.open-bio.org
> http://lists.open-bio.org/mailman/listinfo/biopython-dev
>
>