Skip to content
New issue

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.

Already on GitHub? Sign in to your account

Fix issue with Sphinx 1.3.4 #5872

Merged
merged 8 commits into from
Jan 24, 2016
Merged

Conversation

jenshnielsen
Copy link
Member

Fixes #5869 by rewriting the offending doc string as numpy doc

I also updated .travis.yaml. This originally started with the aim to ensure that the latest version of Sphinx and other dependencies is always installed by only installing Numpy and Pandas from the wheel house. (The wheel house requires manually rebuilding the wheel when a new version is released to pypi and was thus using an older version of Sphinx) The speed benefits are limited since other packages than numpy and pandas are fast to install and we now have the pip wheel cache on Travis anyway.

I took the opportunity to refactor the Travis config a bit more to collect all the pip installs one place and group relevant sections.

@jenshnielsen
Copy link
Member Author

Looks like there is another issue with Sphinx 1.3.4 I will take a look tomorrow

Warning, treated as error:
['find_tex_file(filename, format=None)', ':module: matplotlib.dviread', '', '', '', 'Call :program:`kpsewhich` to find a file in the texmf tree. If', '*format* is not None, it is used as the value for the', ':option:`--format` option.', '', 'Apparently most existing TeX distributions on Unix-like systems', 'use kpathsea. I hear MikTeX (a popular distribution on Windows)', "doesn't use kpathsea, so what do we do? (TODO)", '', '.. seealso::', '', '  `Kpathsea documentation <http://www.tug.org/kpathsea/>`_', '    The library that :program:`kpsewhich` is part of.']:3: WARNING: unknown option: --format

@jenshnielsen
Copy link
Member Author

It looks like that was as simple as removing the :option: key

@jenshnielsen jenshnielsen added this to the Critical bug fix release (1.5.2) milestone Jan 17, 2016
@jenshnielsen
Copy link
Member Author

I think the docs changes should be backported to 1.5.2 but the changes to Travis might not be wort it to backport

@jenshnielsen
Copy link
Member Author

BTW it would be good to convert the rest of that file to numpydoc/napoleon too

@jenshnielsen
Copy link
Member Author

There seems to be an issue with downloading the Cursive font from Googles github account. I should fix that before merging

@jenshnielsen
Copy link
Member Author

Looks like the google fonts are back on github so this is ready for review

@jenshnielsen
Copy link
Member Author

Sphinx 1.3.5 has been released with a fix for the regex issue so we don't strictly need 0ccce1b anymore but it's still an improvement. We do need 7f37443 to have it build cleanly with 1.3.5 thou

I am happy to separate out the travis changes if that makes more sense?

tacaswell added a commit that referenced this pull request Jan 24, 2016
DOC: Fix issue with Sphinx 1.3.4
@tacaswell tacaswell merged commit c259a55 into matplotlib:master Jan 24, 2016
@tacaswell
Copy link
Member

I will cherry pick this back but discard the travis changes

tacaswell added a commit that referenced this pull request Jan 24, 2016
DOC: Fix issue with Sphinx 1.3.4

Discarded changes to .travis.yml from #5872
@tacaswell
Copy link
Member

backported to 1.5.x as b7dfa4f

@jenshnielsen jenshnielsen deleted the sphinx134 branch January 25, 2016 07:29
tacaswell added a commit to tacaswell/matplotlib that referenced this pull request May 22, 2016
DOC: Fix issue with Sphinx 1.3.4

Discarded changes to .travis.yml from matplotlib#5872
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants