# Algorithms docs formatting #1639

Closed
opened this Issue Jul 26, 2017 · 13 comments

Projects
4 participants
Member

### devin-petersohn commented Jul 26, 2017

 The rendered docs are not correctly formatted for the equations. The intradoc links don't work either.

Member

### devin-petersohn commented Jul 26, 2017

 @gunjanbaid will resolve this.
Contributor

### gunjanbaid commented Jul 26, 2017

 Thanks @devin-petersohn, working on this.
Contributor

### gunjanbaid commented Jul 26, 2017

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

### 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
Member

### 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
Contributor

### 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.

Closed

Contributor

### 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.
Member

### 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?
Contributor

### gunjanbaid commented Jul 27, 2017

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

### 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.
Member

### devin-petersohn commented Dec 7, 2017

 @heuermh @fnothaft can this PR be closed?
Member

### 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.
Member

### heuermh commented Dec 13, 2017

 Fixed by #1646.