Function reference

class sphinxcontrib.doxylink.doxylink.Entry(kind, file)

file

Alias for field number 1

kind

Alias for field number 0

class sphinxcontrib.doxylink.doxylink.FunctionList

A FunctionList maps argument lists to specific entries

class sphinxcontrib.doxylink.doxylink.SymbolMap(xml_doc: xml.etree.ElementTree.ElementTree)

A SymbolMap maps symbols to Entries or FunctionLists

sphinxcontrib.doxylink.doxylink.fetch_file(app, source, output_path)

Fetches file and puts it in the desired location if it does not exist yet.

Local files will be copied and remote files will be downloaded. Directories in the output_path get created if needed.

Args:

app: Sphinx’ application instance source (str): Path to local file or URL to remote file output_path (str): Path with filename to copy/download the source to, relative to Sphinx’ output directory

sphinxcontrib.doxylink.doxylink.is_url(str_to_validate)

Helper function to check if string contains URL

Args:

str_to_validate (str): String to validate as URL

Returns:

bool: True if given string is a URL, False otherwise

sphinxcontrib.doxylink.doxylink.match_piecewise(candidates: set, symbol: str, sep: str = '::') → set

Match the requested symbol reverse piecewise (split on ::) against the candidates. This allows you to under-specify the base namespace so that "MyClass" can match my_namespace::MyClass

Args:

candidates: set of possible matches for symbol symbol: the symbol to match against sep: the separator between identifier elements

Returns:

set of matches

sphinxcontrib.doxylink.doxylink.parse_tag_file(doc: xml.etree.ElementTree.ElementTree) → dict

Takes in an XML tree from a Doxygen tag file and returns a dictionary that looks something like:

{'PolyVox': Entry(...),
 'PolyVox::Array': Entry(...),
 'PolyVox::Array1DDouble': Entry(...),
 'PolyVox::Array1DFloat': Entry(...),
 'PolyVox::Array1DInt16': Entry(...),
 'QScriptContext::throwError': FunctionList(...),
 'QScriptContext::toString': FunctionList(...)
 }

Note the different form for functions. This is required to allow for ‘overloading by argument type’.

Parameters:

doc : xml.etree.ElementTree

The XML DOM object

Returns:

a dictionary mapping fully qualified symbols to files

sphinxcontrib.doxylink.doxylink.process_configuration(app, tag_filename, rootdir, pdf_filename)

Processes the configured values for doxylink and doxylink_pdf_files and warns about potential issues.

The type of builder decides which values shall be used.

Args:

app: Sphinx’ application instance tag_filename (str): Path to the Doxygen tag file rootdir (str): Path to the root directory of Doxygen HTML documentation pdf_filename (str): Path to the pdf file; may be empty when LaTeX builder is not used

sphinxcontrib.doxylink.doxylink.report_info(env, msg, docname=None, lineno=None)

Convenience function for logging an informational

Args:

msg (str): Message of the warning docname (str): Name of the document on which the error occured lineno (str): Line number in the document on which the error occured

sphinxcontrib.doxylink.doxylink.report_warning(env, msg, docname=None, lineno=None)

Convenience function for logging a warning

Args:

msg (str): Message of the warning docname (str): Name of the document on which the error occured lineno (str): Line number in the document on which the error occured

sphinxcontrib.doxylink.parsing.normalise(symbol: str) → Tuple[str, str]

Takes a c++ symbol or function and splits it into symbol and a normalised argument list.

Parameters:

symbol : string

A C++ symbol or function definition like PolyVox::Volume, Volume::printAll() const

Returns:

a tuple consisting of two strings: (qualified function name or symbol, normalised argument list)