Skip to content
This repository has been archived by the owner on Oct 17, 2024. It is now read-only.

Temporary fixing of sphinx version to be <1.4 #78

Merged
merged 3 commits into from
Apr 14, 2016

Conversation

bsipocz
Copy link
Member

@bsipocz bsipocz commented Apr 13, 2016

With the new 1.4 sphinx we run into 2 WARNINGS. This affects every package that uses astropy-helpers, thus I think it's sensible to add a requirement for the sphinx version to be <1.4 here and not at the package level.
For packages that run the sphinx build without the -w option, and thus are insensitive of these warnings, there is an option to use the SPHINX_VERSION variable to override this limitation.

We can remove this once the issue is address in the helpers.

The warnings are:

WARNING: while setting up extension astropy_helpers.sphinx.ext.autodoc_enhancements: directive 'autoattribute' is already registered, it will be overridden
WARNING: sphinx.ext.pngmath has been deprecated. Please use sphinx.ext.imgmath instead.

@astrofrog - What do you think?

@bsipocz bsipocz changed the title Fixing typo Temporary fixing of sphinx version to be <1.4 Apr 13, 2016
@bsipocz
Copy link
Member Author

bsipocz commented Apr 13, 2016

(Current failures are addressed by #76, I plan to merge it first, and then rebase this.)

…failures on travis for any packages that uses astropy-helpers and the -w option
if [[ ! -z $SPHINX_VERSION ]]; then
if [[ -z $(grep sphinx $pin_file) ]]; then
echo "matplotlib ${SPHINX_VERSION}*" >> $pin_file
echo "sphinx ${SPHINX_VERSION}*" >> $pin_file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huh, was this a typo before?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, clearly no one tried to set the sphinx version before.

@astrofrog
Copy link
Member

I agree with this solution - it's not like any of the packages are using Sphinx 1.4 features.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants