Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guide on Contributing to the Biopython Tutorial #156

Open
bganglia opened this issue Feb 3, 2020 · 4 comments
Open

Guide on Contributing to the Biopython Tutorial #156

bganglia opened this issue Feb 3, 2020 · 4 comments

Comments

@bganglia
Copy link

bganglia commented Feb 3, 2020

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.

@peterjc
Copy link
Member

peterjc commented Feb 3, 2020

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 biopython/biopython#907

@bganglia
Copy link
Author

bganglia commented Feb 3, 2020

@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?

@peterjc
Copy link
Member

peterjc commented Feb 3, 2020

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?

@bganglia
Copy link
Author

bganglia commented Feb 3, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants