biopython.github.io icon indicating copy to clipboard operation
biopython.github.io copied to clipboard

Guide on Contributing to the Biopython Tutorial

Open bganglia opened this issue 6 years ago • 4 comments

Right now, it is hard to write content for the Biopython Tutorial because there is not much documentation on the tools and conventions used.

I can work on adding some of this documentation to Contributing.md, if that is the right place.

bganglia avatar Feb 03 '20 03:02 bganglia

Good idea, a short entry in the contributing file would be sensible:

https://github.com/biopython/biopython/blob/master/CONTRIBUTING.rst

There is documentation at the start of the Tutorial's main LaTeX file - although it does not mention there is a Makefile which is often easier on a Unix like platform:

https://github.com/biopython/biopython/blob/master/Doc/Tutorial.tex

Don't write too much - we are looking at moving all the LaTeX into reStructuredText and combining this with the API documentation under Sphinx - see https://github.com/biopython/biopython/issues/907

peterjc avatar Feb 03 '20 10:02 peterjc

@peterjc This is what I have written so far: https://github.com/bganglia/biopython/blob/contributing-to-the-documentation/Contributing_to_the_documentation.txt

Perhaps it could be useful to people who are converting the documentation?

bganglia avatar Feb 03 '20 17:02 bganglia

You're going into more detail than I would, but I see better what you had in mind.

How about calling this file Doc/Tutorial/README.rst or Doc/README.rst, and adding one line in the main CONTRIBUTING.rst file pointing there?

peterjc avatar Feb 03 '20 17:02 peterjc

@peterjc Sounds good. I could take out some of the detail if you think it is appropriate.

bganglia avatar Feb 03 '20 17:02 bganglia