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 test docs build on Travis with Sphinx 1.3.0 Edit (Lock travis on 1.2.3 for now) #4213

Merged
merged 2 commits into from Mar 12, 2015

Conversation

jenshnielsen
Copy link
Member

Sphinx 1.3 was just released. This introduced a number of new warnings which caused a test failure and our docs to stop building since we treat warnings as errors.

The test failed due to a renamed theme. So I have changed the config to set the theme name depending on the Sphinx version. (This might need a backport to the color overhaul branch)

The docs fail with:

WARNING: the config value 'html_domain_indices' has type `list', defaults to `bool.'

Which is treated as an error. This looks like a bug in Sphinx it self since according to http://sphinx-doc.org/config.html?highlight=html_domain_indices#confval-html_domain_indices a list should be fully legal

In the interest of having a functional Sphinx build I have disabled the warnings as errors until we can get to the bottom of this.

Set the theme name to default or classic depending on the version of Sphinx used
@jenshnielsen
Copy link
Member Author

I asked a question about this at the Sphinx group https://groups.google.com/forum/#!forum/sphinx-users
Edit: the question is here https://groups.google.com/forum/#!topic/sphinx-users/Ycv1u0OgxMs

@jenshnielsen
Copy link
Member Author

This is not enough, There is also an issue with our plot directive. Removing warnings as errors also result in many additional warnings with failing build of figures not raised as errors.

https://api.travis-ci.org/jobs/54071025/log.txt?deansi=true

Perhaps it is better to nail Sphinx to 1.2.3 for the time being?

@tacaswell
Copy link
Member

👍 for nailing to sphinx 1.2.3 for now

We have a few isseus with 1.3 that still needs to be fixed
@jenshnielsen
Copy link
Member Author

That is done now. I have added #4215 to track getting it working with Sphinx 1.3.0

@jenshnielsen jenshnielsen changed the title Fix test docs build on Travis with Sphinx 1.3.0 Fix test docs build on Travis with Sphinx 1.3.0 Edit (Lock travis on 1.2.3 for now) Mar 12, 2015
tacaswell added a commit that referenced this pull request Mar 12, 2015
CI : test  docs build on Travis with Sphinx 1.3.0 Edit (Lock travis on 1.2.3 for now)
@tacaswell tacaswell merged commit 03b1b2b into matplotlib:master Mar 12, 2015
@jenshnielsen jenshnielsen deleted the fix_docs_build branch March 16, 2015 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants