Skip to content

docutil should be locked at 0.12 to get successful build #195

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

Merged
merged 1 commit into from
May 12, 2017
Merged

docutil should be locked at 0.12 to get successful build #195

merged 1 commit into from
May 12, 2017

Conversation

fbourigault
Copy link
Contributor

When the documentation is build with docutil 0.13.1, the following error occurs:

# Sphinx version: 1.4.9
# Python version: 2.7.13 (CPython)
# Docutils version: 0.13.1 release
# Jinja2 version: 2.9.6
# Last messages:
#   writing output... [ 48%] php-http/documentation/lib/python2.7/site-packages/Jinja2-2.9.6.dist-info/DESCRIPTION
#   writing output... [ 50%] php-http/documentation/lib/python2.7/site-packages/MarkupSafe-1.0.dist-info/DESCRIPTION
#   writing output... [ 51%] php-http/documentation/lib/python2.7/site-packages/Pygments-2.2.0.dist-info/DESCRIPTION
#   writing output... [ 52%] php-http/documentation/lib/python2.7/site-packages/Sphinx-1.4.9.dist-info/DESCRIPTION
#   writing output... [ 54%] php-http/documentation/lib/python2.7/site-packages/alabaster-0.7.10.dist-info/DESCRIPTION
#   writing output... [ 55%] php-http/documentation/lib/python2.7/site-packages/appdirs-1.4.3.dist-info/DESCRIPTION
#   writing output... [ 56%] php-http/documentation/lib/python2.7/site-packages/docutils-0.13.1.dist-info/DESCRIPTION
#   writing output... [ 58%] php-http/documentation/lib/python2.7/site-packages/imagesize-0.7.1.dist-info/DESCRIPTION
#   writing output... [ 59%] php-http/documentation/lib/python2.7/site-packages/packaging-16.8.dist-info/DESCRIPTION
#   writing output... [ 61%] php-http/documentation/lib/python2.7/site-packages/pip-9.0.1.dist-info/DESCRIPTION
# Loaded extensions:
#   sphinxcontrib.spelling (unknown version) from /home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/sphinxcontrib/spelling/__init__.pyc
#   alabaster (0.7.10) from /home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/alabaster/__init__.pyc
Traceback (most recent call last):
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/sphinx/cmdline.py", line 244, in main
    app.build(opts.force_all, filenames)
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/sphinx/application.py", line 297, in build
    self.builder.build_update()
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 251, in build_update
    'out of date' % len(to_build))
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 322, in build
    self.write(docnames, list(updated_docnames), method)
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 360, in write
    self._write_serial(sorted(docnames), warnings)
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 368, in _write_serial
    self.write_doc(docname, doctree)
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/sphinx/builders/html.py", line 448, in write_doc
    self.docwriter.write(doctree, destination)
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/docutils/writers/__init__.py", line 80, in write
    self.translate()
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/sphinx/writers/html.py", line 47, in translate
    self.document.walkabout(visitor)
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/docutils/nodes.py", line 187, in walkabout
    visitor.dispatch_departure(self)
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/docutils/nodes.py", line 1895, in dispatch_departure
    return method(node)
  File "/home/fabien/Projets/php-http/documentation/php-http/documentation/lib/python2.7/site-packages/docutils/writers/_html_base.py", line 671, in depart_document
    assert not self.context, 'len(context) = %s' % len(self.context)
AssertionError: len(context) = 3

According to sphinx-doc/sphinx#3212, locking docutil to 0.12 fixes the issue.

@dbu dbu merged commit 880c3a2 into php-http:master May 12, 2017
@fbourigault fbourigault deleted the fix-docutil-version branch May 12, 2017 08:30
@dbu
Copy link
Contributor

dbu commented May 12, 2017

it works, so fine for me. its the doc so we don't care about re-usability or generality of the build process.

thanks for digging this up!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants