{{ message }}

# bigdatagenomics / adam

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.

# Algorithms docs formatting #1639

Closed
opened this issue Jul 26, 2017 · 13 comments
Closed

# Algorithms docs formatting#1639

opened this issue Jul 26, 2017 · 13 comments
Labels
Projects
Milestone

### devin-petersohn commented Jul 26, 2017

 The rendered docs are not correctly formatted for the equations. The intradoc links don't work either.
added the label Jul 26, 2017
added this to the 0.23.0 milestone Jul 26, 2017

### devin-petersohn commented Jul 26, 2017

 @gunjanbaid will resolve this.

### gunjanbaid commented Jul 26, 2017

 Thanks @devin-petersohn, working on this.

### gunjanbaid commented Jul 26, 2017

 Is there a known solution for rendering equations properly in github markdown? I was not able to find one.

### devin-petersohn commented Jul 27, 2017

 Right now, it looks like the only solution is to render the image elsewhere and use it: github/markup#897

### heuermh commented Jul 27, 2017

 Is there a known solution for rendering equations properly in github markdown? "The input language for mathematics is LaTeX markup." I believe our end goal is to use readthedocs, which runs Sphinx http://www.sphinx-doc.org/en/stable/ext/math.html

### gunjanbaid commented Jul 27, 2017

 Ok, I'll use the latex formatting supported by Sphinx. Just wanted to make sure readability on GitHub was not a concern.
mentioned this issue Jul 27, 2017

### gunjanbaid commented Jul 27, 2017

 @devin-petersohn I fixed the simple latex that can be rendered in Sphinx markdown. The latex in the \begin{algorithm} and \end{algorithm} lines requires additional latex packages. With Sphinx, these are normally included in a conf.py file but I don't know how to enable these for https://adam.readthedocs.io since we don't have Sphinx set up yet. Let me know if you want me to just include an image of these sections for now.

### fnothaft commented Jul 27, 2017

 Thanks @gunjanbaid! WRT Sphinx, perhaps we should plan to move all the docs over to Sphinx as the last thing we do before cutting the release? I can plan to sign on for this task. If so, would you mind adding a conf.py file to the docs in #1645?

### gunjanbaid commented Jul 27, 2017

 @fnothaft Sounds good, I will add a conf.py in.

### fnothaft commented Jul 27, 2017

 Thanks @gunjanbaid! I'm about to open a PR for #1548 that will also add a conf.py, so let's coordinate there.

### devin-petersohn commented Dec 7, 2017

 @heuermh @fnothaft can this PR be closed?

### heuermh commented Dec 7, 2017

 can this PR be closed? This is the issue, #1645 is the pull request. Some of the changes in that pull request may still be applicable, they need to be rebased though.

### heuermh commented Dec 13, 2017

 Fixed by #1646.
closed this Dec 13, 2017
added this to Completed in Release 0.23.0 Jan 4, 2018
to join this conversation on GitHub. Already have an account? Sign in to comment
Projects