Skip to content
This repository has been archived by the owner on Jul 20, 2021. It is now read-only.

ipynb to markdown conversion #140

Merged
merged 27 commits into from
Jun 18, 2015
Merged

ipynb to markdown conversion #140

merged 27 commits into from
Jun 18, 2015

Conversation

gregcaporaso
Copy link
Member

NOT READY FOR MERGE

This pull request converts all ipynb documents to markdown documents. The code that I used for the conversion (which is imperfect) is in a notebook here and rendered here.

  • Need to confirm that all content is present in output - had to fix this for the pairwise alignment chapter as the indentation was messed up (I used a # header in the middle of the notebook).
  • html build times out waiting for a slow-running cell. Need to override the default timeout.
  • fix broken image links (see phylogenetic reconstruction chapter, and check others)
  • where to add "assignment" chapters... (these are now under exercises)
  • get travis working
  • update README Reading IAB to describe build process
  • update Contributing.md, and link to it from Reading IAB (and maybe README)
  • review Installation section of Reading IAB with @ebolyen to confirm the links. Same for README.md.
  • after merge, confirm that Edit on GitHub links are working, and that images are embedded (all links refer to master - they should be right based on spot checks, but hard to test now) related to make biab branch-aware build-iab#6

These commands now work for doing the build:

biab html -i /Users/caporaso/code/An-Introduction-To-Applied-Bioinformatics/book -o ./html
biab notebook -i /Users/caporaso/code/An-Introduction-To-Applied-Bioinformatics/book -o ./ipynb

Fixes #125.
Fixes #98.

* The *easiest* way is to view the static notebooks online using [nbviewer](http://nbviewer.ipython.org/). You should:
* [start here to view the latest release version](http://nbviewer.ipython.org/github/gregcaporaso/An-Introduction-To-Applied-Bioinformatics/blob/0.1.0/Index.ipynb), or
* [start here to view the development version](http://nbviewer.ipython.org/github/gregcaporaso/An-Introduction-To-Applied-Bioinformatics/blob/master/Index.ipynb) (which will have the latest content, but will be less polished and possibly buggy).
IAB is in early development stage. To see the plans for where the project will go, see the [project milestones](https://github.com/gregcaporaso/An-Introduction-To-Applied-Bioinformatics/milestones). **A good example of where we're going** is the [multiple sequence alignment](http://readIAB.org/book/latest/2/3) chapter.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ebolyen, does the second link on this line look possible to get to the static HTML version?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep!

```
pip install numpy
pip install https://github.com/gregcaporaso/An-Introduction-To-Applied-Bioinformatics/archive/0.1.0.tar.gz
wget http://readIAB.org/downloads/0.1.0/iab-notebooks-0.1.0.tgz
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ebolyen, does this link look possible?

@gregcaporaso
Copy link
Member Author

@ebolyen, I just pinged you in a few places where I'm adding links to static html or downloadable content. We can discuss in the morning, just wanted to note them now so I don't forget which ones we need to review.

…y get out of hand, but that will be handled through a toc-level aware biab
@gregcaporaso gregcaporaso self-assigned this Jun 18, 2015
gregcaporaso added a commit that referenced this pull request Jun 18, 2015
ipynb to markdown conversion
@gregcaporaso gregcaporaso merged commit 2bb8e7b into master Jun 18, 2015
@gregcaporaso gregcaporaso deleted the to-rst branch June 18, 2015 16:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

should text be written in markdown and injected into notebooks? add a table of contents object
2 participants