Docs build broken

[tseaver]

$ tox -e docs
...
/home/tseaver/projects/repoze/src/substanced/docs/api.rst:26: WARNING: undefined label: optional_dependencies (if the link has no caption the label must precede a section header)
/home/tseaver/projects/repoze/src/substanced/docs/api.rst:66: WARNING: undefined label: optional_dependencies (if the link has no caption the label must precede a section header)
/home/tseaver/projects/repoze/src/substanced/docs/scripts.rst:4: WARNING: unknown option: --help
generating indices... genindex
Exception occurred:
  File "/home/tseaver/projects/repoze/src/substanced/docs/_themes/substanced/genindex.html", line 49, in block "body"
    {%- for entryname, (links, subitems) in column %}
ValueError: too many values to unpack
The full traceback has been saved in /tmp/sphinx-err-XTPhkb.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: '/home/tseaver/projects/repoze/src/substanced/.tox/docs/bin/sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html'

[cguardia]

Mmm, haven't changed anything there. Will review. Thanks.

[stevepiercy]

@cguardia @Themanwithoutaplan and I removed optional_dependencies from the docs, but not the init.py. Should I restore the optional dependencies section (python-magic on Mac and Win)?

[stevepiercy]

Sphinx is currently at v1.4.6 which fails to build. I downgraded to 1.4.1, and the build failed. Downgraded to 1.3.6, the build succeeds.

My guess is that this is a theme-related issue. We could pin Sphinx to 1.3.6 for now. In a separate issue, I could update the theme to use syntax that Sphinx 1.4.6 prefers for its genindex.html. What do you think @tseaver @cguardia?

[tseaver]

@stevepiercy I would say update the theme to whatever Pyramid is using.

[stevepiercy]

@tseaver I found the fix: https://github.com/sphinx-doc/sphinx/pull/2396/files PR coming soon.

[Themanwithoutaplan]

@stevepiercy python-magic is required and not optional, which is why it's in setup.py. Fortunately, users on MacOS and Windows should no longer have to do a dance to install it, as was once the case.

However, I don't think that has anything to do with this failure. As seems to be borne out by your fix.

[stevepiercy]

@Themanwithoutaplan OK. I created #288 to deal with the warnings.

[stevepiercy]

Well, now the tests are failing. https://travis-ci.org/Pylons/substanced/builds/145647114

[stevepiercy]

Now that docs build, failing tests are revealed. This is out of my league.

$v/bin/nosetests substanced
...
======================================================================
ERROR: test_add (substanced.sdi.views.tests.test_acl.TestAdd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/tests/test_acl.py", line 211, in test_add
    resp = inst()
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/acl.py", line 97, in add
    check_csrf_token(self.request)
  File "/Users/stevepiercy/projects/hack-on-substanced/env/lib/python3.5/site-packages/pyramid/session.py", line 252, in check_csrf_token
    raise BadCSRFToken('check_csrf_token(): Invalid token')
pyramid.exceptions.BadCSRFToken: check_csrf_token(): Invalid token

======================================================================
ERROR: test_add_Everyone (substanced.sdi.views.tests.test_acl.TestAdd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/tests/test_acl.py", line 430, in test_add_Everyone
    resp = inst()
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/acl.py", line 97, in add
    check_csrf_token(self.request)
  File "/Users/stevepiercy/projects/hack-on-substanced/env/lib/python3.5/site-packages/pyramid/session.py", line 252, in check_csrf_token
    raise BadCSRFToken('check_csrf_token(): Invalid token')
pyramid.exceptions.BadCSRFToken: check_csrf_token(): Invalid token

======================================================================
ERROR: test_add_all_permissions (substanced.sdi.views.tests.test_acl.TestAdd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/tests/test_acl.py", line 408, in test_add_all_permissions
    resp = inst()
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/acl.py", line 97, in add
    check_csrf_token(self.request)
  File "/Users/stevepiercy/projects/hack-on-substanced/env/lib/python3.5/site-packages/pyramid/session.py", line 252, in check_csrf_token
    raise BadCSRFToken('check_csrf_token(): Invalid token')
pyramid.exceptions.BadCSRFToken: check_csrf_token(): Invalid token

======================================================================
ERROR: test_add_no_permission (substanced.sdi.views.tests.test_acl.TestAdd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/tests/test_acl.py", line 382, in test_add_no_permission
    resp = inst()
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/acl.py", line 97, in add
    check_csrf_token(self.request)
  File "/Users/stevepiercy/projects/hack-on-substanced/env/lib/python3.5/site-packages/pyramid/session.py", line 252, in check_csrf_token
    raise BadCSRFToken('check_csrf_token(): Invalid token')
pyramid.exceptions.BadCSRFToken: check_csrf_token(): Invalid token

======================================================================
ERROR: test_add_no_principal_selected (substanced.sdi.views.tests.test_acl.TestAdd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/tests/test_acl.py", line 246, in test_add_no_principal_selected
    resp = inst()
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/acl.py", line 97, in add
    check_csrf_token(self.request)
  File "/Users/stevepiercy/projects/hack-on-substanced/env/lib/python3.5/site-packages/pyramid/session.py", line 252, in check_csrf_token
    raise BadCSRFToken('check_csrf_token(): Invalid token')
pyramid.exceptions.BadCSRFToken: check_csrf_token(): Invalid token

======================================================================
ERROR: test_add_puns_DENY_ALL_non_root (substanced.sdi.views.tests.test_acl.TestAdd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/tests/test_acl.py", line 312, in test_add_puns_DENY_ALL_non_root
    resp = inst()
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/acl.py", line 97, in add
    check_csrf_token(self.request)
  File "/Users/stevepiercy/projects/hack-on-substanced/env/lib/python3.5/site-packages/pyramid/session.py", line 252, in check_csrf_token
    raise BadCSRFToken('check_csrf_token(): Invalid token')
pyramid.exceptions.BadCSRFToken: check_csrf_token(): Invalid token

======================================================================
ERROR: test_add_puns_DENY_ALL_root (substanced.sdi.views.tests.test_acl.TestAdd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/tests/test_acl.py", line 277, in test_add_puns_DENY_ALL_root
    resp = inst()
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/acl.py", line 97, in add
    check_csrf_token(self.request)
  File "/Users/stevepiercy/projects/hack-on-substanced/env/lib/python3.5/site-packages/pyramid/session.py", line 252, in check_csrf_token
    raise BadCSRFToken('check_csrf_token(): Invalid token')
pyramid.exceptions.BadCSRFToken: check_csrf_token(): Invalid token

======================================================================
ERROR: test_add_unknown_user (substanced.sdi.views.tests.test_acl.TestAdd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/tests/test_acl.py", line 348, in test_add_unknown_user
    resp = inst()
  File "/Users/stevepiercy/projects/hack-on-substanced/substanced/substanced/sdi/views/acl.py", line 97, in add
    check_csrf_token(self.request)
  File "/Users/stevepiercy/projects/hack-on-substanced/env/lib/python3.5/site-packages/pyramid/session.py", line 252, in check_csrf_token
    raise BadCSRFToken('check_csrf_token(): Invalid token')
pyramid.exceptions.BadCSRFToken: check_csrf_token(): Invalid token

----------------------------------------------------------------------
Ran 1755 tests in 8.661s

FAILED (errors=8)

[tseaver]

@stevepiercy that is #285. I would say go ahead and merge your docs fix anyhow.