Correct $ref links in extensions documentation server relative location.

chrome/common/extensions/docs/server2/reference_resolver.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 from copy import deepcopy
 import logging
 import re
 import string
 
 from file_system import FileNotFoundError
@@ skipping 152 matching lines @@
       return ref_data
     logging.error('$ref %s could not be resolved in namespace %s.' %
         (ref, namespace))
     type_name = ref.rsplit('.', 1)[-1]
     return {
       'href': '#type-%s' % type_name,
       'text': title or ref,
       'name': ref
     }
 
-  def ResolveAllLinks(self, text, namespace=None):
+  def ResolveAllLinks(self, text, relative_to='', namespace=None):
     """This method will resolve all $ref links in |text| using namespace
     |namespace| if not None. Any links that cannot be resolved will be replaced
     using the default link format that |SafeGetLink| uses.
+    The links will be generated relative to |relative_to|.
     """
     if text is None or '$ref:' not in text:
       return text
+
+    link_prefix = ''
+    # requestPath should be of the form (apps|extensions)/...../page.html.
+    # link_prefix should  that the target will point to
+    # (apps|extensions)/target.html.
+    if relative_to is not '':

[not at google - send to devlin, 2013/11/27 21:46:09]

"is not" is for object identity. I don't know whether that works for ''. It
would be !=. In any case this branch isn't quite right? My logic ... not quite
right either? If relative_to is "foo" then .count('/') is 0 so you'll be
multiplying '../' by -1.

... I leave it to you to fix it, but I would imagine that there wouldn't be a
need to do any actual string comparison for |relative_to|.

[benwells, 2013/12/02 06:32:32]

Nice catch. Turns out multiplying a sequence by a negative number is equivalent
to multiplying by 0 (see note 2 under the table at
http://docs.python.org/2/library/stdtypes.html#typesseq). So we're all good here
by just removing the broken if statement.

+      link_prefix = '../' * (relative_to.count('/') - 1)
     split_text = text.split('$ref:')
     # |split_text| is an array of text chunks that all start with the
     # argument to '$ref:'.
     formatted_text = [split_text[0]]
     for ref_and_rest in split_text[1:]:
       title = None
       if ref_and_rest.startswith('[') and ']' in ref_and_rest:
         # Text was '$ref:[foo.bar maybe title] other stuff'.
         ref_with_title, rest = ref_and_rest[1:].split(']', 1)
         ref_with_title = ref_with_title.split(None, 1)
         if len(ref_with_title) == 1:
           # Text was '$ref:[foo.bar] other stuff'.
           ref = ref_with_title[0]
         else:
           # Text was '$ref:[foo.bar title] other stuff'.
           ref, title = ref_with_title
       else:
         # Text was '$ref:foo.bar other stuff'.
         match = self._bare_ref.match(ref_and_rest)
         if match is None:
           ref = ''
           rest = ref_and_rest
         else:
           ref = match.group()
           rest = ref_and_rest[match.end():]
 
       ref_dict = self.SafeGetLink(ref, namespace=namespace, title=title)
-      formatted_text.append('<a href="%(href)s">%(text)s</a>%(rest)s' %
-          { 'href': ref_dict['href'], 'text': ref_dict['text'], 'rest': rest })
+      formatted_text.append('<a href="%s%s">%s</a>%s' %
+          (link_prefix, ref_dict['href'], ref_dict['text'], rest))
     return ''.join(formatted_text)