[Biopython-dev] Documentation

[Vince S. Buffalo]

I am familiar with git, github and Sphinx, but not epydoc. Would initial
draft version of the tutorial to Sphinx be a good first move?

best,
Vince

On Tue, Jul 13, 2010 at 4:04 PM, Peter <biopython at maubp.freeserve.co.uk>wrote:

> On Tue, Jul 13, 2010 at 11:24 PM, Vince S. Buffalo <vsbuffalo at gmail.com>
> wrote:
> > Hi All,
> >
> > I'd like to become more active in the Biopython project, and porting the
> > documentation to Sphinx seems like an excellent way to begin. Is there a
> > wiki or other website for allocating docstrings/other documentation to be
> > rewritten in reStructuredText?
> >
> > Vince
>
> Hi Vince,
>
> Volunteers to help would be great. In terms of a wiki or website system,
> I guess you are aware of or have used the NumPy system. They put a
> lot of effort into setting up a workflow to edit docstrings via a wiki,
> before
> manual merging into the code base. We don't have anything like that.
>
> For now, it would be a case of making a fork on github, and editing
> Python source code files one by one to convert their docstrings into
> reStructuredText (plus checking the output works in epydoc, and
> making sure this doesn't break any doctests). We'd then be able
> to pull your changes into the trunk (manually).
>
> Are you familiar with git, github, epydoc and/or Sphinx?
>
> Regards,
>
> Peter
>



-- 
Vince Buffalo
Programmer
Bioinformatics Core
UC Davis Genome Center
University of California, Davis

"There's real poetry in the real world. Science is the poetry of reality."
-Richard Dawkins