.. DoxySummary documentation master file, created by
   sphinx-quickstart on Sat Jun 25 16:59:20 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Sphinx-DoxySummary documentation!
==============================================

Introduction
------------

Doxysummary is a Sphinx extension for creating autosummary with entries from
xml files generated by Doxygen.


Installation
------------

Install from source:

.. code-block:: console

   $ git clone https://github.com/quocdang1998/doxysummary.git
   $ cd doxysummary
   $ pip install .

Run example:

.. code-block:: console

   $ pip install --upgrade sphinx-rtd-theme
   $ cd example
   $ doxygen Doxyfile
   $ make html


User Guide
----------

1. In ``conf.py``, add ``sphinx_doxysummary`` to the list of extensions

.. code-block:: python3

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

2. In ``conf.py``, set the config variable ``doxygen_xml`` to list of
   parent directories containing xml files, separated by ","

.. code-block:: python3

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

3. In the input rst file, add the following directive:

.. code-block:: restructuredtext

   .. doxysummary::
      :toctree: generated

      spam::Foo
      Bar

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: User Guide

   userguide

Packages
--------

The process of creating doxysummary table can be divided into 3 stages:

1. :doc:`xml_tree` (when Sphinx initialize Builder instance)
2. :doc:`generate` (when Sphinx initialize Builder instance)
3. :doc:`directive` (when Sphinx read the directive ``.. doxysummary::``)

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Python Packages

   xml_tree
   generate
   directive
   utils

Licence
-------

.. literalinclude:: ../../LICENCE
   :language: text