Building docs has issues with ipython version 7.0.0. Created a condition in the docs-requirements.txt to not allow installing the specific version. by Anirudhsekar96 · Pull Request #12583 · matplotlib/matplotlib

Anirudhsekar96 · 2018-10-21T18:05:12Z

I have included a condition to not install ipython version 7.0.0 in the docs-requirement.txt file. This is because Ipython version 7.0.0 wasn't allowing the make html command to build the doc files.

QuLogic · 2018-10-21T18:43:47Z

What issues exactly?

Anirudhsekar96 · 2018-10-21T19:09:29Z

Exception occurred:
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/IPython/sphinxext/ipython_directive.py", line 582, in process_input
    raise RuntimeError('Non Expected warning in `{}` line {}'.format(filename, lineno))
RuntimeError: Non Expected warning in `/media/anirudh/Data/Code/matplotlib/doc/users/prev_whats_new/whats_new_1.5.rst` line 51
The full traceback has been saved in /tmp/sphinx-err-7sd1qvzv.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Makefile:20: recipe for target 'html' failed
make: *** [html] Error 2

This was the error that I encountered while issuing the command "make html"

QuLogic · 2018-10-21T19:13:54Z

That's only the end of the message; please post the entire thing.

Anirudhsekar96 · 2018-10-21T19:24:56Z

Traceback (most recent call last):
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/sphinx/cmd/build.py", line 304, in build_main
    app.build(args.force_all, filenames)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/sphinx/application.py", line 341, in build
    self.builder.build_update()
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 347, in build_update
    len(to_build))
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 360, in build
    updated_docnames = set(self.read())
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 468, in read
    self._read_serial(docnames)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 490, in _read_serial
    self.read_doc(docname)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 534, in read_doc
    doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/sphinx/io.py", line 318, in read_doc
    pub.publish()
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/core.py", line 217, in publish
    self.settings)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/readers/__init__.py", line 72, in read
    self.parse()
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/readers/__init__.py", line 78, in parse
    self.parser.parse(self.input, document)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/sphinx/parsers.py", line 88, in parse
    self.statemachine.run(inputstring, document, inliner=self.inliner)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 171, in run
    input_source=document['source'])
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/statemachine.py", line 239, in run
    context, state, transitions)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/statemachine.py", line 460, in check_line
    return method(match, context, next_state)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2753, in underline
    self.section(title, source, style, lineno - 1, messages)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 327, in section
    self.new_subsection(title, lineno, messages)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 395, in new_subsection
    node=section_node, match_titles=True)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 282, in nested_parse
    node=node, match_titles=match_titles)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 196, in run
    results = StateMachineWS.run(self, input_lines, input_offset)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/statemachine.py", line 239, in run
    context, state, transitions)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/statemachine.py", line 460, in check_line
    return method(match, context, next_state)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2753, in underline
    self.section(title, source, style, lineno - 1, messages)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 327, in section
    self.new_subsection(title, lineno, messages)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 395, in new_subsection
    node=section_node, match_titles=True)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 282, in nested_parse
    node=node, match_titles=match_titles)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 196, in run
    results = StateMachineWS.run(self, input_lines, input_offset)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/statemachine.py", line 239, in run
    context, state, transitions)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/statemachine.py", line 460, in check_line
    return method(match, context, next_state)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2326, in explicit_markup
    nodelist, blank_finish = self.explicit_construct(match)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2338, in explicit_construct
    return method(self, expmatch)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2081, in directive
    directive_class, match, type_name, option_presets)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2130, in run_directive
    result = directive_instance.run()
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/IPython/sphinxext/ipython_directive.py", line 1004, in run
    rows, figure = self.shell.process_block(block)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/IPython/sphinxext/ipython_directive.py", line 711, in process_block
    self.process_input(data, input_prompt, lineno)
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/IPython/sphinxext/ipython_directive.py", line 582, in process_input
    raise RuntimeError('Non Expected warning in `{}` line {}'.format(filename, lineno))
RuntimeError: Non Expected warning in `/media/anirudh/Data/Code/matplotlib/doc/users/prev_whats_new/whats_new_1.5.rst` line 51

This was the log file that was created

jklymak · 2018-10-21T19:46:31Z

This has been fixed on master already I think

tacaswell · 2018-10-21T20:11:23Z

@jklymak on our master or ipython master?

…the docs

QuLogic · 2018-10-21T21:07:06Z

@Anirudhsekar96 No, we need to see the warning that it's talking about before the traceback, not the log of the traceback.

jklymak · 2018-10-21T21:09:43Z

You get that error running our docs on older prs that haven’t been rebased.

Anirudhsekar96 · 2018-10-21T21:17:48Z

@Anirudhsekar96 No, we need to see the warning that it's talking about before the traceback, not the log of the traceback.


>>>-------------------------------------------------------------------------
Warning in /media/anirudh/Data/Code/matplotlib/doc/users/prev_whats_new/whats_new_1.5.rst at block ending on line 51
Specify :okwarning: as an option in the ipython:: block to suppress this message
----------------------------------------------------------------------------
/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/matplotlib/figure.py:448: UserWarning: Matplotlib is currently using agg, which is a non-GUI backend, so cannot show the figure.
  % get_backend())
<<<-------------------------------------------------------------------------

Exception occurred:
  File "/home/anirudh/anaconda/envs/matplot/lib/python3.7/site-packages/IPython/sphinxext/ipython_directive.py", line 582, in process_input
    raise RuntimeError('Non Expected warning in `{}` line {}'.format(filename, lineno))
RuntimeError: Non Expected warning in `/media/anirudh/Data/Code/matplotlib/doc/users/prev_whats_new/whats_new_1.5.rst` line 51
The full traceback has been saved in /tmp/sphinx-err-7sd1qvzv.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Makefile:20: recipe for target 'html' failed
make: *** [html] Error 2

Is this the one?

QuLogic · 2018-10-21T21:27:54Z

Yes, that's the one; it should have been fixed by #12322. Did you try with the latest master?

Anirudhsekar96 · 2018-10-21T21:38:30Z

Yes, I forked it today from the main master branch.

thoo · 2018-10-21T22:38:45Z

@QuLogic I just cloned and checked it a few minutes ago on my mac and I got the same error. I have to downgrade to ipython==6.5.0 to get it fix.

tacaswell · 2018-10-22T12:43:47Z

The issue shows up when trying to build the docs from the master branch against a 3.0.0 installation.

I don't see how the changes in #12322 would affect this...

Carreau · 2018-10-22T14:37:32Z

That's a change in IPython, you will be able to opt-out with IPython 7.1 with ipython_warning_is_error = False. We had too many case of docs silently failing on RTD, so this was turned on. Sorry for the regression.

Anirudhsekar96 · 2018-10-22T18:03:19Z

If the issue has been rectified in IPython 7.1, then wouldn't it be better if we add a condition which skips just the problematic IPython 7.0.0 and 7.0.1 (the condition which I have added in my pull request)?

Carreau · 2018-10-22T19:19:53Z

If the issue has been rectified in IPython 7.1, then wouldn't it be better if we add a condition which skips just the problematic IPython 7.0.0 and 7.0.1 (the condition which I have added in my pull request)?

You can, but the IPython directive will still be stricter in 7.1 than in 6.x, so you either need to set ipython_warn_is_error = False and/or fix the problematic code blocks.

tacaswell · 2018-10-22T19:30:25Z

If this was an intentional change to IPython, lets try and fix the offending codeblock

anntzer · 2018-11-01T09:56:48Z

Closed by #12684, AFAICT.

tacaswell added this to the v3.0.0-doc milestone Oct 21, 2018

Ipython 7.0.0 has issues. Please use a diffrent version for building …

a818630

…the docs

Anirudhsekar96 force-pushed the master branch from 0dee93a to a818630 Compare October 21, 2018 20:18

Ipython version 7.0.1 also seems to suffer the same issue as 7.0.0

196e90e

anntzer mentioned this pull request Oct 21, 2018

Docs/contrib #12584

Closed

6 tasks

tacaswell mentioned this pull request Oct 22, 2018

Prepare for ipython 7.1 stricter ipython directive. #12587

Closed

anntzer closed this Nov 1, 2018

anntzer added the Documentation label Nov 1, 2018

QuLogic removed this from the v3.0.0-doc milestone Nov 27, 2018

Uh oh!

Conversation

Anirudhsekar96 commented Oct 21, 2018

Uh oh!

QuLogic commented Oct 21, 2018

Uh oh!

Anirudhsekar96 commented Oct 21, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

QuLogic commented Oct 21, 2018

Uh oh!

Anirudhsekar96 commented Oct 21, 2018 • edited by QuLogic Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jklymak commented Oct 21, 2018

Uh oh!

tacaswell commented Oct 21, 2018

Uh oh!

QuLogic commented Oct 21, 2018

Uh oh!

jklymak commented Oct 21, 2018

Uh oh!

Anirudhsekar96 commented Oct 21, 2018

Uh oh!

QuLogic commented Oct 21, 2018

Uh oh!

Anirudhsekar96 commented Oct 21, 2018

Uh oh!

thoo commented Oct 21, 2018

Uh oh!

tacaswell commented Oct 22, 2018

Uh oh!

Carreau commented Oct 22, 2018

Uh oh!

Anirudhsekar96 commented Oct 22, 2018

Uh oh!

Carreau commented Oct 22, 2018

Uh oh!

tacaswell commented Oct 22, 2018

Uh oh!

anntzer commented Nov 1, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Anirudhsekar96 commented Oct 21, 2018 •

edited

Loading

Anirudhsekar96 commented Oct 21, 2018 •

edited by QuLogic

Loading