sphinx-doxysummary 1.0.1

Sphinx extension for Doxygen entries.

Doxysummary

A Sphinx extension for creating autosummary with entries from xml files generated by Doxygen.

Installation

To install doxysummary:

$ pip install .

To build examples:

$ cd example
$ doxygen Doxyfile
$ make html

To compile the doc:

$ cd docs
$ make html

Usage

In conf.py, add sphinx_doxysummary to the list of extensions, and set the config variable doxygen_xml to the list of locations of xml files:

extensions = [...
    'sphinx_doxysummary',
    ...
]

doxygen_xml = ['./xml']  # each directory corresponds to one Doxygen project

Then in the input rst file, add the following directive:

.. doxysummary::
   :toctree: generated
   :template: cppclass.rst

   spam::Foo  # this is comment
   Bar
   ~a_long_name_space::MyClass  # only MyClass appears in the summary table

Note:

• Anything placed after # is line comment.
• Display non-scoped name in the summary table by placing a ~ at the beginning of the entry

Options

• :template: (optional) : name of the template.

• :toctree: (optional) : directory in which rst files are generated.

• :scope: (optional) : current scope (namespace, class, enum, etc) of the items.

  .. doxysummary::
     :toctree: generated
     :template: cppclass.rst
     :scope: fruit
  
     Cherry  # as same as fruit::Cherry
     Orange  # as same as fruit::Orange
  

User can customize the displayed name of the item in the autosummary table with aliasing:

.. doxysummary::
   :toctree: generated
   :template: cppclass.rst

   fruit::Cherry "CppCherry"
   fruit::Orange "CppOrange"  # display name is CppOrange and CppCherry

Note: Alias containing space is not recommended.

Function overloading is supported:

.. doxysummary::
   :toctree: generated

   func_overload()
   func_overload(int a) "func_overload(int)"
   func_overload(char,char)
   func_overload(const std::vector<double>&)
   func_overload(double&&)
   func_overload(long\*)
   func_overload(int (&)[3])
   func_overload(int(\*)(double))
   func_overload(int MyClass::*)