xhale package

xhale.xhale.extract_tag(inventory, url)

extract data from sphinx inventory.

The extracted datas come from a C++ project documented using Breathe. The structure of the inventory is a dictionary with the following keys

  • cpp:class (class names)
  • cpp:function (functions or class methods)
  • cpp:type (type names)

each value of this dictionary is again a dictionary with

  • key : the name of the element
  • value : a tuple where the third index is the url to the corresponding documentation
Parameters:
  • inventory (dict) – sphinx inventory
  • url (url of the documentation) –
Returns:

  • dictionary with keys class, class_methods, func, type
  • but now the class methods are with their class.
xhale.xhale.get_sphinx_inventory(url)

get the sphinx inventory from a url.

Parameters:url (url of the package where find objects.inv file) –
Returns:the inventory
Return type:dict
xhale.xhale.write_tagfile(tag_elem, package, url)

write the doxygen tagfile (package.tag).

Parameters:
  • tag_elem (dictionary given by extract_tag) –
  • package (name of the package) –
  • url (url of the documentation) –