parameters: (self, string, relative_path_to_root)
return_statement: return re.sub(SYMBOL_REFERENCE_RE, one_ref, string)
docstring: Replace "@{symbol}" references with links to symbol's documentation page.
  
      This functions finds all occurrences of "@{symbol}" in `string`
      and replaces them with markdown links to the documentation page
      for "symbol".
  
      `relative_path_to_root` is the relative path from the document
      that contains the "@{symbol}" reference to the root of the API
      documentation that is linked to. If the containing page is part of
      the same API docset, `relative_path_to_root` can be set to
      `os.path.dirname(documentation_path(name))`, where `name` is the
      python name of the object whose documentation page the reference
      lives on.
  
      Args:
        string: A string in which "@{symbol}" references should be replaced.
        relative_path_to_root: The relative path from the containing document to
          the root of the API documentation that is being linked to.
  
      Returns:
        `string`, with "@{symbol}" references replaced by Markdown links.
docstring_summary: Replace "@{symbol}" references with links to symbol's documentation page.
docstring_tokens: Replace @ { symbol } references with links to symbol s documentation page .
function: def replace_references(self, string, relative_path_to_root):
      """Replace "@{symbol}" references with links to symbol's documentation page.
  
      This functions finds all occurrences of "@{symbol}" in `string`
      and replaces them with markdown links to the documentation page
      for "symbol".
  
      `relative_path_to_root` is the relative path from the document
      that contains the "@{symbol}" reference to the root of the API
      documentation that is linked to. If the containing page is part of
      the same API docset, `relative_path_to_root` can be set to
      `os.path.dirname(documentation_path(name))`, where `name` is the
      python name of the object whose documentation page the reference
      lives on.
  
      Args:
        string: A string in which "@{symbol}" references should be replaced.
        relative_path_to_root: The relative path from the containing document to
          the root of the API documentation that is being linked to.
  
      Returns:
        `string`, with "@{symbol}" references replaced by Markdown links.
      """
      def one_ref(match):
        return self._one_ref(match, relative_path_to_root)
  
      return re.sub(SYMBOL_REFERENCE_RE, one_ref, string)
function_tokens: def replace_references ( self , string , relative_path_to_root ) : def one_ref ( match ) : return self . _one_ref ( match , relative_path_to_root ) return re . sub ( SYMBOL_REFERENCE_RE , one_ref , string )