Docs build broken #286

tseaver · 2016-07-18T16:29:31Z

$ 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 · 2016-07-18T16:31:36Z

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

stevepiercy · 2016-07-18T18:28:58Z

@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 · 2016-07-18T19:51:58Z

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 · 2016-07-18T20:00:48Z

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

stevepiercy · 2016-07-18T20:08:23Z

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

- closes Pylons#286

Themanwithoutaplan · 2016-07-18T20:15:09Z

@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 · 2016-07-18T20:21:14Z

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

stevepiercy · 2016-07-18T20:30:59Z

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

stevepiercy · 2016-07-18T20:46:46Z

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 · 2016-07-18T21:16:36Z

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

tseaver added bug docs important labels Jul 18, 2016

stevepiercy added a commit to stevepiercy/substanced that referenced this issue Jul 18, 2016

Fixes broken docs build, due to update in Sphinx 1.4.x

98d6040

- closes Pylons#286

stevepiercy mentioned this issue Jul 18, 2016

Fixes broken docs build, due to update in Sphinx 1.4.x #287

Merged

stevepiercy mentioned this issue Jul 18, 2016

Fix warnings when building docs #288

Closed

stevepiercy closed this as completed in #287 Jul 18, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs build broken #286

Docs build broken #286

tseaver commented Jul 18, 2016

cguardia commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

tseaver commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

Themanwithoutaplan commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

tseaver commented Jul 18, 2016 •

edited

Loading

Docs build broken #286

Docs build broken #286

Comments

tseaver commented Jul 18, 2016

cguardia commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

tseaver commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

Themanwithoutaplan commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

stevepiercy commented Jul 18, 2016

tseaver commented Jul 18, 2016 • edited Loading

tseaver commented Jul 18, 2016 •

edited

Loading