Welcome to Sphinx-DoxySummary documentation!
Doxysummary is a Sphinx extension for creating autosummary with entries from xml files generated by Doxygen.
Install from source:
$ git clone https://github.com/quocdang1998/doxysummary.git $ cd doxysummary $ pip install .
$ pip install --upgrade sphinx-rtd-theme $ cd example $ doxygen Doxyfile $ make html
sphinx_doxysummaryto the list of extensions
extensions = [... 'sphinx_doxysummary', ... ]
conf.py, set the config variable
doxygen_xmlto list of parent directories containing xml files, separated by “,”
doxygen_xml = ['./xml1', '../project2/xml'] # each directory corresponds to one Doxygen project
In the input rst file, add the following directive:
.. doxysummary:: :toctree: generated spam::Foo Bar
The process of creating doxysummary table can be divided into 3 stages:
Generate XML tree (when Sphinx initialize Builder instance)
Generate rst files (when Sphinx initialize Builder instance)
Processing directives (when Sphinx read the directive
MIT License Copyright (c) 2022 quocdang1998 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.