Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Problems building docs with sphinx 1.5.6

See original GitHub issue

I’m attempting to build the documentation for dask 1.15.1 for the Debian package, using sphinx 1.5.6, pandas 0.20.3, python 3.5.3 and numpydoc 0.7.0, and it’s currently failing to build from source.

With the error:

Exception occurred: File “/usr/lib/python3/dist-packages/numpydoc/docscrape.py”, line 343, in _pae raise ValueError(msg) ValueError: The section Notes appears twice in the docstring of None in None. The full traceback has been saved in /tmp/sphinx-err-_mt1fzrj.log, if you want .

If I disable this code in dask/utils.py:derived_from python if len(not_supported) > 0: note = ("\n Notes\n -----\n" " Dask doesn't support the following argument(s).\n\n") args = ''.join([' * {0}\n'.format(a) for a in not_supported]) doc = doc + note + args It’ll build, I also found changing Notes to Extra Notes, and adding extra ------ in the restructured text heading markup worked.

Issue Analytics

State:
Created 6 years ago
Comments:10 (10 by maintainers)

Top GitHub Comments

1reaction

detroutcommented, Jul 21, 2017

The fix in #2512 that resolved the exception was pinning numpydoc to 0.6.0. At least for me, the doc build fails with numpydoc 0.7.0 and with numpydoc 0.8.0.dev.0 (commit 057ef572dd5ea547af2832e1b68d934cf953eafe)

0reactions

mrocklincommented, Oct 23, 2018

I believe that this has been resolved. The doc building on RTD seems to work well. Regardless, this issue has gone stale. Closing.

Top Results From Across the Web

Changelog - Sphinx documentation

#10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA's flit project as a build backend. Patch by Adam Turner....

Sphinx Documentation - Read the Docs

Building your documentation in other formats . ... There are some problems one commonly runs into while authoring reST documents:.

Issue 30380: Sphinx 1.6.1 raising new warnings in docs build

The problem is that Sphinx 1.6.1 adds some new warnings that then is flagging the docs build as failing. To fix this we...

sphinx-js - PyPI

cd my-project sphinx-quickstart > Root path for the documentation [.]: docs > Separate source and build directories (y/n) [n]: > Name prefix for...

How to turn warnings into errors when building sphinx ...

If instead, like me, you're using make to build your html docs with Sphinx, then you can do this to turn warnings into...