KeyError: 'refdoc' with Sphinx tip

68 views
Skip to first unread message

Timmie

unread,
Jan 11, 2010, 7:03:40 AM1/11/10
to sphinx-dev
Hello,
I am experiencing the following error:

# Sphinx version: 1.0
# Docutils version: 0.6 release
# Jinja2 version: 2.2.1
Traceback (most recent call last):
File "C:\Python26\lib\site-packages\sphinx-1.0dev_20100110-py2.6.egg
\sphinx\cmdline.py", line 170, in main
app.build(all_files, filenames)
File "C:\Python26\lib\site-packages\sphinx-1.0dev_20100110-py2.6.egg
\sphinx\application.py", line 130, in build
self.builder.build_update()
File "C:\Python26\lib\site-packages\sphinx-1.0dev_20100110-py2.6.egg
\sphinx\builders\__init__.py", line 265, in build_update
'out of date' % len(to_build))
File "C:\Python26\lib\site-packages\sphinx-1.0dev_20100110-py2.6.egg
\sphinx\builders\__init__.py", line 320, in build
self.write(docnames, list(updated_docnames), method)
File "C:\Python26\lib\site-packages\sphinx-1.0dev_20100110-py2.6.egg
\sphinx\builders\__init__.py", line 358, in write
doctree = self.env.get_and_resolve_doctree(docname, self)
File "C:\Python26\lib\site-packages\sphinx-1.0dev_20100110-py2.6.egg
\sphinx\environment.py", line 1002, in get_and_resolve_doctree
self.resolve_references(doctree, docname, builder)
File "C:\Python26\lib\site-packages\sphinx-1.0dev_20100110-py2.6.egg
\sphinx\environment.py", line 1273, in resolve_references
self.warn(node['refdoc'],
File "C:\Python26\lib\site-packages\docutils-0.6-py2.6.egg\docutils
\nodes.py", line 537, in __getitem__
return self.attributes[key]
KeyError: 'refdoc'

The Sphinx documentation itself builds well without errors. It happens
only with my own files.

What could be the cause?

Thanks,
Timmie

Georg Brandl

unread,
Jan 12, 2010, 4:23:46 AM1/12/10
to sphin...@googlegroups.com
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

To fix a bug with LaTeX writing, I changed the cross-reference nodes to
include a reference to their source documents. Either your environment
is out of date (which it shouldn't since I've increased ENV_VERSION, so
it should be rebuilt automatically), or an extension you have activated
creates its own reference nodes without setting the 'refdoc'. I've now
pushed a fix to trunk that makes refdoc optional, since I could imagine
extensions creating reference nodes are not uncommon :)

(Although these extensions will have to be adapted for 1.0 final anyway.)

cheers,
Georg
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.14 (GNU/Linux)

iEYEARECAAYFAktMP6IACgkQN9GcIYhpnLDEsACfWW5uQ9rPxV9cizqFAmVLRC26
dOAAoKcgZs9PlIgPkU5Q9yKAdsySqhUc
=tj09
-----END PGP SIGNATURE-----

Timmie

unread,
Jan 13, 2010, 9:06:50 AM1/13/10
to sphinx-dev
[...]

> it should be rebuilt automatically), or an extension you have activated
> creates its own reference nodes without setting the 'refdoc'.  I've now
> pushed a fix to trunk that makes refdoc optional, since I could imagine
> extensions creating reference nodes are not uncommon :)
>
> (Although these extensions will have to be adapted for 1.0 final anyway.)
I updated numpy, matplotlib extensions. and reinstalled the latest
Sphinx.
Now everything works as expected.

Thanks.

Reply all
Reply to author
Forward
0 new messages