search

mjmlab / pyinseq

Python pipeline for analyzing INSeq Insertion Sequencing data
BSD 3-Clause "New" or "Revised" License
6 stars 6 forks source link

Improve appearance of documentation #20

Closed mandel01 closed 7 years ago

mandel01 commented 8 years ago

e.g. File formats (gbk and how it can have multiple contigs; ftt format).

titipata commented 8 years ago

We can start gh-pages branch for documentation and move markdown documentation there. This will be rendered at mandel01.github.io/pyinseq. There are few Jekyll documentation themes that we can select such as jekyll-docs-template.

titipata commented 8 years ago

@mandel01, I put documentation in gh-pages branch here. This is for now serve at http://titipata.github.io/pyinseq/. You can take a look and feel free to let me know if it's good or not.

mandel01 commented 8 years ago

I'm going to change the name of this issue to deal with the appearance of the documentation and then move items about the content of the documentation to a different issue - #35.

mandel01 commented 8 years ago

I like the idea of having a clean landing page for the project, with documentation that is autogenerated. I looked at the linked templates but I first need to read more about using jekyll and github pages. Is all of the text on the page autogenerated from the docs/ directory or is some of it static in the html?

titipata commented 8 years ago

I think there is a way to do that as I searched through: https://gist.github.com/cobyism/4730490. In Jekyll case, we can sync /docs folder with Jekyll _posts folder.

mandel01 commented 7 years ago

Hi @titipata. It has taken me a long time to get to some of these issues. I learned how to use sphinx and applied that for the documentation. It does not auto-update but that will be for a future update.