Skip to content

Docs build failure on Launchpad. #2982

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.

Sign up for GitHub

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

Jump to bottom
Closed
takluyver opened this issue Apr 16, 2014 · 7 comments · Fixed by #2983
Closed

Docs build failure on Launchpad. #2982

takluyver opened this issue Apr 16, 2014 · 7 comments · Fixed by #2983
Assignees
@tacaswell
Milestone
v1.4.0

Comments

@takluyver
Copy link
Contributor

Probably due to #2836. I'm starting to think we should make numpydoc more flexible, so not everything has to be a definition list.

reading sources... [  3%] api/figure_api

Exception occurred:
  File "/usr/lib/python2.7/dist-packages/numpydoc/docscrape.py", line 208, in parse_item_name
    raise ValueError("%s is not a item name" % text)
ValueError: :func:`~matplotlib.Figure.set_size_inches` is not a item name
@tacaswell
Copy link
Member

Sorry about that. Is there a simple way to change #2836 to fix this?

@takluyver
Copy link
Contributor Author

I think it's expecting a definition list, so it would probably work if the see also section looked something like this:

set_size_inches
    :func:`~matplotlib.Figure.set_size_inches`

I'm also going to file a bug on numpydoc to try and improve this, because we've run into it several times in IPython.

@takluyver
Copy link
Contributor Author

Correction after reading the docs docs: it should be just the function name without the Sphinx markup, i.e.

matplotlib.Figure.set_size_inches

@tacaswell tacaswell self-assigned this Apr 16, 2014
@tacaswell tacaswell added this to the v1.4.0 milestone Apr 16, 2014
tacaswell added a commit to tacaswell/matplotlib that referenced this issue Apr 16, 2014
@tacaswell
DOC/BUG : fixed sphinx markup
1dffcd1 
 - issue introduced in matplotlib#2836
 - closes matplotlib#2982
@tacaswell tacaswell mentioned this issue Apr 16, 2014
Merged
@tacaswell
Copy link
Member

@takluyver That take care of it?

@takluyver
Copy link
Contributor Author

Sorry, I don't have a local checkout handy, this was from the Launchpad daily builds. I think it should fix it - if you merge it, I'll let you know tomorrow when the next build runs.

@takluyver
Copy link
Contributor Author

Yes, that fixed it; we're back to failing on #2916 now.

@tacaswell
Copy link
Member

Progress I guess....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tacaswell tacaswell

Labels
None yet
Projects
None yet
Milestone
v1.4.0
Development

Successfully merging a pull request may close this issue.

DOC/BUG : fixed sphinx markup tacaswell/matplotlib
3 participants
@tacaswell @takluyver @anntzer