Skip to content

Have Sphinx use sphinx.ext.imgmath instead of sphinx.ext.pngmath

Marek Szuba requested to merge build_docs_imgmath into version/2.5

Created by: mkszuba

Use case

The Sphinx extension sphinx.ext.pngmath is deprecated, which presumably means it will disappear at some point. There seem to be only two places in eHive documentation which rely on this yet we do use it.

Description

sphinx.ext.imgmath is a drop-in replacement for it sphinx.ext.pngmath (its default output format is PNG and under the bonnet both use dvipng) so all this PR does is update the Sphinx configuration file to use the former. Now not only do we no longer get the deprecation warning but could now easily switch to SVG output by passing '-D imgmath_image_format=svg' to sphinx-build.

Possible Drawbacks

Sphinx versions older than 1.4 will no longer be supported. Mind you, 1.4 just under 3 years old now and our requirements file already demands 1.6.5.

Testing

Have you added/modified unit tests to test the changes?

no

If so, do the tests pass/fail?

N/A

Have you run the entire test suite and no regression was detected?

I have rebuilt HTML documentation with imgmath, for both PNG and SVG output. No problems in either case.

Merge request reports