xhale

Converter from sphinx and breathe inventory files to doxygen tag files

Introduction

xhale transforms an inventory file given by sphinx into a doxygen tag file. This package is mainly used for xeus-cling in order to be able to get the documentation of a C++ package in a jupyter notebook.

To create your tag file, you just have to use the script xhale and give the following arguments

  • the package name which will be the name of the tag file
  • the url where to find the inventory file

Here is an example

xhale -p xtensor --url https://xtensor.readthedocs.io/en/latest/

Contents:

Licensing

We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.

Indices and tables