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

[RFC] Fix multi repo external references #530

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 36 additions & 0 deletions breathe/directives.py
Expand Up @@ -21,6 +21,8 @@
from sphinx.writers.text import TextWriter
from sphinx.builders.text import TextBuilder
from sphinx.domains import cpp
from sphinx.transforms.post_transforms import SphinxPostTransform
from sphinx import addnodes

import os
import fnmatch
Expand Down Expand Up @@ -782,6 +784,38 @@ def purge_doc(self, app, env, docname):
del self.app.env.breathe_file_state[filename]


class DoxygenIdentifierReferenceResolver(SphinxPostTransform):

# must run before sphinx ReferenceResolver
default_priority = 5
# only resolve identifier xrefs for these domains
domains = set(['c', 'cpp'])

def run(self, **kwargs):
for node in self.document.traverse(addnodes.pending_xref):
if node['reftype'] != 'identifier':
continue

if 'refdomain' not in node or node['refdomain'] not in self.domains:
continue

# skip when information required by intersphinx is available already
if 'refdoc' in node:
continue

nodecopy = node.deepcopy()
contnode = node[0].deepcopy()

# 'refdoc' is used by intersphinx to correctly adjust relative
# paths when resolving external references
nodecopy['refdoc'] = self.env.docname

newnode = self.app.emit_firstresult('missing-reference', self.env,
nodecopy, contnode)
if newnode is not None:
node.replace_self(newnode)


# Setup
# -----

Expand Down Expand Up @@ -840,6 +874,8 @@ def add_directive(name):
directive_factory.create_function_directive_container(),
)

app.add_post_transform(DoxygenIdentifierReferenceResolver)

app.add_config_value("breathe_projects", {}, True)
app.add_config_value("breathe_default_project", "", True)
# Provide reasonable defaults for domain_by_extension mapping. Can be overridden by users.
Expand Down