Skip to content
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

Set refdomain for refnodes to fix build with Sphinx 1.6.3 #13

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mitya57
Copy link

@mitya57 mitya57 commented Oct 3, 2017

Otherwise the documentation build and tests fail with:

Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/sphinx/cmdline.py", line 306, in main
    app.build(opts.force_all, filenames)
  File "/usr/lib/python2.7/dist-packages/sphinx/application.py", line 339, in build
    self.builder.build_update()
  File "/usr/lib/python2.7/dist-packages/sphinx/builders/__init__.py", line 331, in build_update
    'out of date' % len(to_build))
  File "/usr/lib/python2.7/dist-packages/sphinx/builders/__init__.py", line 344, in build
    updated_docnames = set(self.env.update(self.config, self.srcdir, self.doctreedir))
  File "/usr/lib/python2.7/dist-packages/sphinx/environment/__init__.py", line 584, in update
    self._read_serial(docnames, self.app)
  File "/usr/lib/python2.7/dist-packages/sphinx/environment/__init__.py", line 603, in _read_serial
    self.read_doc(docname, app)
  File "/usr/lib/python2.7/dist-packages/sphinx/environment/__init__.py", line 730, in read_doc
    domain.process_doc(self, docname, doctree)
  File "/usr/lib/python2.7/dist-packages/sphinx/domains/std.py", line 576, in process_doc
    self.note_citation_refs(env, docname, document)
  File "/usr/lib/python2.7/dist-packages/sphinx/domains/std.py", line 593, in note_citation_refs
    if node['refdomain'] == 'std' and node['reftype'] == 'citation':
  File "/usr/lib/python2.7/dist-packages/docutils/nodes.py", line 567, in __getitem__
    return self.attributes[key]
KeyError: 'refdomain'

This is a result of sphinx-doc/sphinx@69b090f.

Otherwise the documentation build fails with:

Traceback (most recent call last):
  [...]
  File "/usr/lib/python2.7/dist-packages/sphinx/environment/__init__.py", line 730, in read_doc
    domain.process_doc(self, docname, doctree)
  File "/usr/lib/python2.7/dist-packages/sphinx/domains/std.py", line 576, in process_doc
    self.note_citation_refs(env, docname, document)
  File "/usr/lib/python2.7/dist-packages/sphinx/domains/std.py", line 593, in note_citation_refs
    if node['refdomain'] == 'std' and node['reftype'] == 'citation':
  File "/usr/lib/python2.7/dist-packages/docutils/nodes.py", line 567, in __getitem__
    return self.attributes[key]
KeyError: 'refdomain'
@funkyfuture
Copy link

This would solve #12.

yungyuc added a commit to yungyuc/solvcon that referenced this pull request Nov 1, 2017
ignatenkobrain/sphinxcontrib-issuetracker#13

Pull the project into doc ext directory to fix it since the upstream project doesn't seem to be maintained.
@danc86
Copy link

danc86 commented Dec 8, 2017

@ignatenkobrain any chance you could hit the merge button on this one? It is affecting our builds in rawhide so it would be good to get this fixed.

@ralphbean
Copy link

Still affecting our ability to build our docs with tox.

@funkyfuture
Copy link

sphinx.ext.extlinks is a suitable replacement for this extension.

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.

None yet

4 participants