[Biopython-dev] [Biopython - Feature #3219] Port Biopython documentation to Sphinx

redmine at redmine.open-bio.org redmine at redmine.open-bio.org
Wed Jul 11 18:13:40 UTC 2012

Issue #3219 has been updated by Peter Cock.

Seems they were interested in translating it into Chinese, based on a Google translation of this post:
Feature #3219: Port Biopython documentation to Sphinx

Author: Eric Talevich
Status: In Progress
Priority: Low
Assignee: Biopython Dev Mailing List
Category: Documentation
Target version: 

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.


Mailing list discussion:

Numpy's approach:

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

More information about the Biopython-dev mailing list