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

kinto: documentation fails to build as of 2.1.2 #6544

Closed
glasserc opened this issue Jul 1, 2019 · 2 comments
Closed

kinto: documentation fails to build as of 2.1.2 #6544

glasserc opened this issue Jul 1, 2019 · 2 comments

Comments

@glasserc
Copy link

glasserc commented Jul 1, 2019

An automatic dependency bump (Kinto/kinto#2182) of Sphinx from 2.1.1 to 2.1.2 is failing. We receive the error:

Warning, treated as error:
/home/travis/build/Kinto/kinto/kinto/core/openapi.py:docstring of kinto.core.openapi.OpenAPI.generate::py:class reference target not found: dict

OpenAPI.generate doesn't actually have a docstring; it overrides https://github.com/Cornices/cornice.ext.swagger/blob/master/cornice_swagger/swagger.py#L398. This has :rtype: dict. We have other functions with this :rtype: dict field in our project and we have ("py:obj", "dict") on our nitpick_ignore list (since Sphinx 2.1.1; Kinto/kinto#2171).

$ git clone https://github.com/Kinto/kinto
$ cd kinto
$ make docs

Expected behavior
I didn't see anything in the changelog that would explain why this would fail.

Your project
https://github.com/Kinto/kinto/
https://travis-ci.org/Kinto/kinto/jobs/548162675 shows a failing build.

Environment info

  • OS: Linux (container on TravisCI)
  • Python version: 3.6.3
  • Sphinx version: 2.1.2
  • Sphinx extensions: sphinx.ext.autodoc, sphinxcontrib.httpdomain, sphinx.ext.extlinks, sphinx.ext.intersphinx; the sphinx_rtd_theme
  • Extra tools: Readthedocs, Travis
@tk0miya
Copy link
Member

tk0miya commented Jul 7, 2019

Sorry for inconvenience. The behavior of 2.1.1 was not expected. And it was fixed at 2.1.2 (refs: #6478). So please update your nitpick_ignore setting to ("py:class", "dict").

@tk0miya tk0miya removed this from the 2.2.0 milestone Jul 7, 2019
@glasserc
Copy link
Author

glasserc commented Jul 8, 2019

Thank you very much!

@glasserc glasserc closed this as completed Jul 8, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants