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

[redmine at redmine.open-bio.org]

Issue #3219 has been updated by Eric Talevich.


Colin Lappala offered to start working on this just a couple days ago:
http://lists.open-bio.org/pipermail/biopython-dev/2012-June/009708.html

I played with Sphinx a little bit when I filed this bug last year, but didn't accomplish anything significant. I am not aware of any public branch that could serve as a starting point, but in any case, the first step is to port the docstrings from epytext to reStructuredText. That part can be done in small pieces concurrently, I think.
----------------------------------------
Feature #3219: Port Biopython documentation to Sphinx
https://redmine.open-bio.org/issues/3219

Author: Eric Talevich
Status: In Progress
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 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