[](https://www.python.org/)
[](https://www.sphinx-doc.org/en/master/)
[](https://doxygen.nl/)
[](https://github.com/quocdang1998/doxysummary/blob/master/LICENCE)
[](https://doxysummary.readthedocs.io/en/latest/)
[](https://doxysummary.readthedocs.io/_/downloads/en/latest/pdf/)
Doxysummary
===========
A Sphinx extension for creating autosummary with entries from xml files
generated by Doxygen.
Installation
------------
To install doxysummary:
```console
$ pip install .
```
To build examples:
```console
$ cd example
$ doxygen Doxyfile
$ make html
```
To compile the doc:
```console
$ 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:
```Python
extensions = [...
'sphinx_doxysummary',
...
]
doxygen_xml = ['./xml'] # each directory corresponds to one Doxygen project
```
Then in the input rst file, add the following directive:
```reStructuredText
.. 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.
```reStructuredText
.. doxysummary::
:toctree: generated
:template: cppclass.rst
:scope: fruit
Cherry # as same as fruit::Cherry
Orange # as same as fruit::Orange
```
From version 1.2.0, user can customize the displayed name of the item in the
autosummary table with aliasing:
```reStructuredText
.. 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.
New in version 2.2.0: function overloading is officially supported.
```reStructuredText
.. doxysummary::
:toctree: generated
func_overload()
func_overload(int a) "func_overload(int)"
func_overload(char,char)
func_overload(std::vector<double>)
Raw data
{
"_id": null,
"home_page": "https://github.com/quocdang1998/doxysummary",
"name": "sphinx-doxysummary",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Sphinx, autosummary, Doxygen",
"author": "Dinh Quoc Dang Nguyen",
"author_email": "quocdang1998@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5d/5b/bf4196ebc56f7e5a4a3bd5df602d6b242ed50736ec1be43bf81facc52599/sphinx-doxysummary-2.3.4.tar.gz",
"platform": "Microsoft :: Windows",
"description": "[](https://www.python.org/)\n[](https://www.sphinx-doc.org/en/master/)\n[](https://doxygen.nl/)\n\n[](https://github.com/quocdang1998/doxysummary/blob/master/LICENCE)\n[](https://doxysummary.readthedocs.io/en/latest/)\n[](https://doxysummary.readthedocs.io/_/downloads/en/latest/pdf/)\n\nDoxysummary\n===========\n\nA Sphinx extension for creating autosummary with entries from xml files\ngenerated by Doxygen.\n\n\nInstallation\n------------\n\nTo install doxysummary:\n\n```console\n$ pip install .\n```\n\nTo build examples:\n\n```console\n$ cd example\n$ doxygen Doxyfile\n$ make html\n```\n\nTo compile the doc:\n\n```console\n$ cd docs\n$ make html\n```\n\nUsage\n-----\n\nIn `conf.py`, add `sphinx_doxysummary` to the list of extensions, and set the\nconfig variable `doxygen_xml` to the list of locations of xml files:\n\n```Python\nextensions = [...\n 'sphinx_doxysummary',\n ...\n]\n\ndoxygen_xml = ['./xml'] # each directory corresponds to one Doxygen project\n```\n\nThen in the input rst file, add the following directive:\n\n```reStructuredText\n.. doxysummary::\n :toctree: generated\n :template: cppclass.rst\n\n spam::Foo # this is comment\n Bar\n ~a_long_name_space::MyClass # only MyClass appears in the summary table\n```\n\n**Note**:\n- Anything placed after `#` is line comment.\n- Display non-scoped name in the summary table by placing a `~` at the\n beginning of the entry\n\nOptions\n-------\n\n- `:template:` (optional) : name of the template.\n\n- `:toctree:` (optional) : directory in which rst files are generated.\n\n- `:scope:` (optional) : current scope (namespace, class, enum, etc) of the\nitems.\n\n ```reStructuredText\n .. doxysummary::\n :toctree: generated\n :template: cppclass.rst\n :scope: fruit\n\n Cherry # as same as fruit::Cherry\n Orange # as same as fruit::Orange\n ```\n\nFrom version 1.2.0, user can customize the displayed name of the item in the\nautosummary table with aliasing:\n```reStructuredText\n.. doxysummary::\n :toctree: generated\n :template: cppclass.rst\n\n fruit::Cherry \"CppCherry\"\n fruit::Orange \"CppOrange\" # display name is CppOrange and CppCherry\n```\n\n**Note**: Alias containing space is not recommended.\n\nNew in version 2.2.0: function overloading is officially supported.\n```reStructuredText\n.. doxysummary::\n :toctree: generated\n\n func_overload()\n func_overload(int a) \"func_overload(int)\"\n func_overload(char,char)\n func_overload(std::vector<double>)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx extension for Doxygen entries.",
"version": "2.3.4",
"project_urls": {
"Homepage": "https://github.com/quocdang1998/doxysummary"
},
"split_keywords": [
"sphinx",
" autosummary",
" doxygen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5f39f9f241fec5da049689d0d10553eff339574adab6d0a1f84053c4c8318bca",
"md5": "e9f13fc0f15ace1fef29c806bd04cb06",
"sha256": "cb4caaf75a2a3eb0cbaaadcf6dfb2f09d016f1514ea69a2104f6775920b5ecb9"
},
"downloads": -1,
"filename": "sphinx_doxysummary-2.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9f13fc0f15ace1fef29c806bd04cb06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 16212,
"upload_time": "2024-04-22T11:16:12",
"upload_time_iso_8601": "2024-04-22T11:16:12.872769Z",
"url": "https://files.pythonhosted.org/packages/5f/39/f9f241fec5da049689d0d10553eff339574adab6d0a1f84053c4c8318bca/sphinx_doxysummary-2.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d5bbf4196ebc56f7e5a4a3bd5df602d6b242ed50736ec1be43bf81facc52599",
"md5": "11a77828d14684e96c0a2b0ed6c4c202",
"sha256": "830f2dd57410911d873def1de56e47ab8c5156355a2be915381a4c42d935f6a9"
},
"downloads": -1,
"filename": "sphinx-doxysummary-2.3.4.tar.gz",
"has_sig": false,
"md5_digest": "11a77828d14684e96c0a2b0ed6c4c202",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 15427,
"upload_time": "2024-04-22T11:16:14",
"upload_time_iso_8601": "2024-04-22T11:16:14.054537Z",
"url": "https://files.pythonhosted.org/packages/5d/5b/bf4196ebc56f7e5a4a3bd5df602d6b242ed50736ec1be43bf81facc52599/sphinx-doxysummary-2.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 11:16:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "quocdang1998",
"github_project": "doxysummary",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sphinx-doxysummary"
}
JSON
