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

add a table of contents object #98

Closed
gregcaporaso opened this issue Mar 30, 2015 · 5 comments · Fixed by #140
Closed

add a table of contents object #98

gregcaporaso opened this issue Mar 30, 2015 · 5 comments · Fixed by #140

Comments

@gregcaporaso
Copy link
Member

This would probably be a pd.DataFrame with a multi-index, but I need a single object that I can query to get chapter names and links, rather than hard-coding these through-out the text. This might be a little clunky because you can't execute python code in a markdown cell, but that will be better than having broken links and outdated chapter names scattered throughout the text.

@gregcaporaso
Copy link
Member Author

The way to handle the references is probably with some kind of box that could be in an executable python cell that we'd just drop after the referring text. For example, something like this (but obviously less hideous):

screenshot 2015-03-30 10 00 38

This is similar to what I have in mind for #76.

@gregcaporaso gregcaporaso added this to the 0.1.1 milestone Mar 30, 2015
@ebolyen
Copy link
Collaborator

ebolyen commented Mar 30, 2015

@gregcaporaso that solution should be pretty straight-forward. I might have time this week to work on that if you'd like.

@gregcaporaso
Copy link
Member Author

All chapters currently have issues with the chapter label. See here. One of the pieces of metadata associated with each chapter should ultimately be its GitHub issue number.

@gregcaporaso
Copy link
Member Author

Here's a prototype of what the data frame TOC might ultimately look like. I'm going to keep this updated and use it until we have a page with all of this information. The columns in this spreadsheet that say "Inherit from issue labels" are ones that we won't want to include in the object, but rather that we'll want to pull from GitHub when we show this table on the project website.

@jairideout jairideout removed their assignment Jun 4, 2015
@gregcaporaso
Copy link
Member Author

This is now complete as part of #140 and through gregcaporaso/build-iab.

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 a pull request may close this issue.

3 participants