Giter VIP home page Giter VIP logo

Comments (5)

seanfisk avatar seanfisk commented on August 11, 2024

Update: After applying #55, the docs build is failing here:

$ tox -e docs
GLOB sdist-make: /Users/sean/tmp/cookie-sphinx/python-nameless/setup.py
docs inst-nodeps: /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/dist/nameless-0.1.0.zip
docs installed: alabaster==0.7.7,Babel==2.2.0,docutils==0.12,imagesize==0.7.0,Jinja2==2.8,MarkupSafe==0.23,nameless==0.1.0,Pygments==2.1.3,pytz==2016.3,six==1.10.0,snowballstemmer==1.2.1,Sphinx==1.4,sphinx-rtd-theme==0.1.9
docs runtests: PYTHONHASHSEED='1440827637'
docs runtests: commands[0] | sphinx-build -E -b html docs dist/docs
Running Sphinx v1.4
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 9 source files that are out of date
updating environment: 9 added, 0 changed, 0 removed
reading sources... [ 11%] authors
reading sources... [ 22%] changelog
reading sources... [ 33%] contributing
reading sources... [ 44%] index
reading sources... [ 55%] installation
reading sources... [ 66%] readme
reading sources... [ 77%] reference/index
reading sources... [ 88%] reference/nameless
reading sources... [100%] usage

README.rst:11: WARNING: nonlocal image URI found: https://readthedocs.org/projects/python-nameless/badge/?style=flat
README.rst:0: WARNING: nonlocal image URI found: https://travis-ci.org/ionelmc/python-nameless.svg?branch=master
README.rst:0: WARNING: nonlocal image URI found: https://ci.appveyor.com/api/projects/status/github/ionelmc/python-nameless?branch=master&svg=true
README.rst:0: WARNING: nonlocal image URI found: https://requires.io/github/ionelmc/python-nameless/requirements.svg?branch=master
README.rst:0: WARNING: nonlocal image URI found: https://codecov.io/github/ionelmc/python-nameless/coverage.svg?branch=master
README.rst:16: WARNING: nonlocal image URI found: https://img.shields.io/pypi/v/nameless.svg?style=flat
README.rst:16: WARNING: nonlocal image URI found: https://img.shields.io/pypi/dm/nameless.svg?style=flat
README.rst:16: WARNING: nonlocal image URI found: https://img.shields.io/pypi/wheel/nameless.svg?style=flat
README.rst:16: WARNING: nonlocal image URI found: https://img.shields.io/pypi/pyversions/nameless.svg?style=flat
README.rst:16: WARNING: nonlocal image URI found: https://img.shields.io/pypi/implementation/nameless.svg?style=flat
README.rst:18: WARNING: nonlocal image URI found: https://readthedocs.org/projects/python-nameless/badge/?style=flat
README.rst:22: WARNING: nonlocal image URI found: https://travis-ci.org/ionelmc/python-nameless.svg?branch=master
README.rst:26: WARNING: nonlocal image URI found: https://ci.appveyor.com/api/projects/status/github/ionelmc/python-nameless?branch=master&svg=true
README.rst:30: WARNING: nonlocal image URI found: https://requires.io/github/ionelmc/python-nameless/requirements.svg?branch=master
README.rst:34: WARNING: nonlocal image URI found: https://codecov.io/github/ionelmc/python-nameless/coverage.svg?branch=master
README.rst:38: WARNING: nonlocal image URI found: https://img.shields.io/pypi/v/nameless.svg?style=flat
README.rst:42: WARNING: nonlocal image URI found: https://img.shields.io/pypi/dm/nameless.svg?style=flat
README.rst:46: WARNING: nonlocal image URI found: https://img.shields.io/pypi/wheel/nameless.svg?style=flat
README.rst:50: WARNING: nonlocal image URI found: https://img.shields.io/pypi/pyversions/nameless.svg?style=flat
README.rst:54: WARNING: nonlocal image URI found: https://img.shields.io/pypi/implementation/nameless.svg?style=flat
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 11%] authors
writing output... [ 22%] changelog
writing output... [ 33%] contributing
writing output... [ 44%] index
writing output... [ 55%] installation
writing output... [ 66%] readme
writing output... [ 77%] reference/index
writing output... [ 88%] reference/nameless
writing output... [100%] usage

generating indices... genindex
Exception occurred:
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/themes/basic/genindex-single.html", line 40, in block "body"
    {%- for entryname, (links, subitems) in column %}
ValueError: too many values to unpack
The full traceback has been saved in /var/folders/mj/nmpw6v8s15z_cj39dmv0fk9m0000gn/T/sphinx-err-Xij9Gn.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!
ERROR: InvocationError: '/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/bin/sphinx-build -E -b html docs dist/docs'
___________________________________ summary ____________________________________
ERROR:   docs: commands failed

Full traceback:

# Sphinx version: 1.4
# Python version: 2.7.11 (CPython)
# Docutils version: 0.12 release
# Jinja2 version: 2.8
# Last messages:
#   writing output... [ 33%] contributing
#   writing output... [ 44%] index
#   writing output... [ 55%] installation
#   writing output... [ 66%] readme
#   writing output... [ 77%] reference/index
#   writing output... [ 88%] reference/nameless
#   writing output... [100%] usage
#   
#   generating indices...
#   genindex
# Loaded extensions:
#   sphinx.ext.coverage (1.4) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/ext/coverage.pyc
#   alabaster (0.7.7) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/alabaster/__init__.pyc
#   sphinx.ext.autosummary (1.4) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/ext/autosummary/__init__.pyc
#   sphinx.ext.doctest (1.4) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/ext/doctest.pyc
#   sphinx.ext.ifconfig (1.4) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/ext/ifconfig.pyc
#   sphinx.ext.autodoc (1.4) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/ext/autodoc.pyc
#   sphinx.ext.napoleon (1.4) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/ext/napoleon/__init__.pyc
#   sphinx.ext.viewcode (1.4) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/ext/viewcode.pyc
#   sphinx.ext.todo (1.4) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/ext/todo.pyc
#   sphinx.ext.extlinks (1.4) from /Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/ext/extlinks.pyc
Traceback (most recent call last):
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/cmdline.py", line 244, in main
    app.build(opts.force_all, filenames)
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/application.py", line 287, in build
    self.builder.build_update()
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 251, in build_update
    'out of date' % len(to_build))
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 325, in build
    self.finish()
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/builders/html.py", line 461, in finish
    self.finish_tasks.add_task(self.gen_indices)
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/util/parallel.py", line 40, in add_task
    res = task_func()
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/builders/html.py", line 477, in gen_indices
    self.write_genindex()
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/builders/html.py", line 535, in write_genindex
    'genindex-single.html')
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/builders/html.py", line 802, in handle_page
    output = self.templates.render(templatename, ctx)
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/jinja2glue.py", line 138, in render
    return self.environment.get_template(template).render(context)
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/jinja2/environment.py", line 989, in render
    return self.environment.handle_exception(exc_info, True)
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/jinja2/environment.py", line 754, in handle_exception
    reraise(exc_type, exc_value, tb)
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/themes/basic/genindex-single.html", line 32, in top-level template code
    {% set title = _('Index') %}
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx_rtd_theme/layout.html", line 150, in top-level template code
    {% block body %}{% endblock %}
  File "/Users/sean/tmp/cookie-sphinx/python-nameless/.tox/docs/lib/python2.7/site-packages/sphinx/themes/basic/genindex-single.html", line 40, in block "body"
    {%- for entryname, (links, subitems) in column %}
ValueError: too many values to unpack

The problem appears to be with the index. Returning html_split_index in docs/conf.py to its default of True allows the build to complete successfully, but that's all I've been able to ascertain as of now. A split index appears to work fine with a blank Sphinx 1.4 project (generated with sphinx-quickstart), so the problem will require a little more debugging.

Thanks, and sorry for all the posts today 😐

from cookiecutter-pylibrary.

ionelmc avatar ionelmc commented on August 11, 2024

Here it say True is the default: http://www.sphinx-doc.org/en/stable/config.html#confval-html_split_index

It looks like they added a broken change: sphinx-doc/sphinx#2396

from cookiecutter-pylibrary.

seanfisk avatar seanfisk commented on August 11, 2024

@ionelmc Ah, you're right about that bug! Also, your pull request title was priceless 😀

from cookiecutter-pylibrary.

ionelmc avatar ionelmc commented on August 11, 2024

Ok so they are quite slow to release the fix ...

I've got some time to check what that option actually does, and I don't think we should have True as default anyway. Changed in 7dbbdd1.

from cookiecutter-pylibrary.

seanfisk avatar seanfisk commented on August 11, 2024

@ionelmc Sounds good to me! Thanks 👍

from cookiecutter-pylibrary.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.