Couldn't build the docs with the latest docutils (0.11)
|Reported by:||bruno@…||Owned by:||nobody|
|Has patch:||no||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
Today I've tried to build the django docs using a fresh virtualenv with only one installed package: Sphinx.
Here is the pip freeze output:
Jinja2==2.7 MarkupSafe==0.18 Pygments==1.6 Sphinx==1.2b1 distribute==0.6.34 docutils==0.11
the make html command threw me this error output:
$ make html sphinx-build -b djangohtml -n -d _build/doctrees . _build/html Running Sphinx v1.2b1 loading pickled environment... failed: env version not current loading intersphinx inventory from http://docs.python.org/2.7/objects.inv... loading intersphinx inventory from http://packages.python.org/six/objects.inv... loading intersphinx inventory from http://sphinx.pocoo.org/objects.inv... loading intersphinx inventory from http://simplejson.readthedocs.org/en/latest/objects.inv... building [djangohtml]: targets for 264 source files that are out of date updating environment: 264 added, 0 changed, 0 removed reading sources... [100%] topics/testing/overview looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 2%] faq/install Exception occurred: File "/home/novapost/.virtualenvs/DOCS/local/lib/python2.7/site-packages/docutils/writers/html4css1/__init__.py", line 1559, in depart_table self.compact_p = self.context.pop() IndexError: pop from empty list The full traceback has been saved in /tmp/sphinx-err-AXWeLA.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. Either send bugs to the mailing list at <http://groups.google.com/group/sphinx-users/>, or report them in the tracker at <http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks! make: *** [html] Erreur 1
After questionning the IRC django channel on Freenode, it happened to be solved using this "trick"
pip uninstall docutils pip install docutils==0.10
So far, I could build another Sphinx documentation with the previous setup (including docutils==0.11), but I couldn't do it for Django docs.
Looks like Django documentation is incompatible with the latest docutils version. Maybe it has something to do with docutils itself, but I thought it would be valuable to mention it here, in order to give user instructions about this (i.e. install docutils==0.10 in the docs/README file)