mathjax and sphinx for local docs builds about chiantipy HOT 8 CLOSED

my local sphinx does find the math package but this displays the whole entity as a subscript. In some places, someone has used :mathrm: which works on rtd but not locally and looks much better.

Actually,the astropy_helpers probably sets me up for imgmath and I have not really tried that yet.

I am using Firefox.

I will try imgmath next and see what happens. If that doesn't work, I will try a few more things but I don't expect to be on this forever.

from chiantipy.

Ah ok so the equations just show up as :math:$\my_latex_equation$ literals?

I have included a couple of math expressions using :math: (for inline) or .. math:: for separate equations in several docstrings. From what I understand, these are general Sphinx expressions for typesetting math and should not be dependent on what type of renderer (e.g. mathjax, imgmath, pngmath) you're using.

Yes, astropy-helpers uses imgmath locally. I wonder if there is something wrong with your sphinx installation? Have you tried uninstalling and reinstalling sphinx? What version of sphinx are you using? Perhaps your installed version is missing the math support extension?

I'm also using the sphinx_rtd_theme package, though I don't think this should make any difference...

All of this is reminding me too that we should mention somewhere in the docs that if people want to build the docs locally, they will need a few extra dependencies.

from chiantipy.

I think I have it working now
In astropy_helpers/astropy_helpers/sphinx/conf.py, the extension imgmath is loaded. I changed this to mathjax
so far so good

from chiantipy.

Hmm strange. Perhaps there is just some issue with imgmath on your local setup? Either way, glad it is working now.

I would avoid committing any changes you've made to astropy-helpers to the upstream. Since this is a submodule, it would create a bit of a headache if we ever wanted to pull down upstream changes from that repo.

from chiantipy.

I am going to check this one more time -- there are only a few edits involved to the ion class and then push it to the upstream package and see how if the docs are built on RTD.
Let me know if this is not something to do right now.

from chiantipy.

This is PR #31 ? It looks like there are currently conflicts so you might have trouble merging into the upstream.

Looking at the commits, it doesn't look like anything will break RTD.

We should think about implementing some automatic builds via Travis CI as well so that it will be easier to say when PRs break the install at least. Later on tests could be added for better coverage. These also get run when a PR is submitted so if a PR breaks the install/fails a test, you know before the merge happens.

from chiantipy.

Sounds like a good idea. I followed the link you gave to 'Travis CI' and logged in via github. Now they want to access my github data. Is that the way to go?

from chiantipy.

Sounds like this has been resolved in that #33 has been merged. Closing.

from chiantipy.