<!--
=====================================================================================
C O P Y R I G H T
-------------------------------------------------------------------------------------
Copyright (c) 2022 by Robert Bosch GmbH. All rights reserved.
Author(s):
- Markus Braun, :em engineering methods AG (contracted by Robert Bosch GmbH)
- Nirmal Sasidharan, Robert Bosch Gmbh
- Wolfgang Ulmer, Robert Bosch GmbH
=====================================================================================
-->
<div align="center">
<img src="https://raw.githubusercontent.com/boschglobal/doxysphinx/main/docs/resources/doxysphinx_logo.svg" alt="doxysphinx" width=500 />
</div>
---
[](LICENSE.md)
[](https://pypi.org/project/doxysphinx/)
[](https://pypi.org/project/doxysphinx/)
[](https://github.com/boschglobal/doxysphinx/actions/workflows/ci.yml)
[](https://github.com/boschglobal/doxysphinx/actions/workflows/cd.yml)
Doxysphinx is a [Doxygen](https://doxygen.nl) and [Sphinx](https://sphinx-doc.org) integration tool.
It is an easy-to-use cli tool and typically runs right after Doxygen generation.
It reuses the Doxygen generated HTML output and integrates it into Sphinx document generation.
With this, Doxysphinx supports all known Doxygen features and at the same time integrates well with the Sphinx output (for example, Sphinx-Themes, search etc.).
Doxysphinx, also supports [restructured text (rST) annotations](https://github.com/boschglobal/doxysphinx/blob/main/docs/using_rst_in_doxygen.md) within C++ files.
Internally, Doxysphinx creates an rST file for each (Doxygen) HTML file and includes the HTML using `.. raw:: html` directive.
Later Sphinx picks up these rST files and creates an integrated documentation.
Check out Doxysphinx alternatives [here](https://github.com/boschglobal/doxysphinx/blob/main/docs/alternatives.md).
## Links
📚 [Doxysphinx Overview](https://boschglobal.github.io/doxysphinx)
🚀 [Getting Started](https://boschglobal.github.io/doxysphinx/docs/getting_started.html)
💻 [Developer Quickstart](https://boschglobal.github.io/doxysphinx/docs/dev_guide.html)
🤖 [Releases](https://github.com/boschglobal/doxysphinx/releases)
Raw data
{
"_id": null,
"home_page": "https://github.com/boschglobal/doxysphinx",
"name": "doxysphinx",
"maintainer": "Nirmal Sasidharan",
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": "nirmal.sasidharan@de.bosch.com",
"keywords": "DaC, docs-as-code, doxygen, sphinx",
"author": "Nirmal Sasidharan",
"author_email": "nirmal.sasidharan@de.bosch.com",
"download_url": "https://files.pythonhosted.org/packages/84/53/1079743ab3478caac5aa2a01acc0b19c3bf82156c71f50b71b08df85b104/doxysphinx-3.3.8.tar.gz",
"platform": null,
"description": "<!--\n=====================================================================================\n C O P Y R I G H T\n-------------------------------------------------------------------------------------\n Copyright (c) 2022 by Robert Bosch GmbH. All rights reserved.\n\n Author(s):\n - Markus Braun, :em engineering methods AG (contracted by Robert Bosch GmbH)\n - Nirmal Sasidharan, Robert Bosch Gmbh\n - Wolfgang Ulmer, Robert Bosch GmbH\n=====================================================================================\n-->\n\n<div align=\"center\">\n\n<img src=\"https://raw.githubusercontent.com/boschglobal/doxysphinx/main/docs/resources/doxysphinx_logo.svg\" alt=\"doxysphinx\" width=500 />\n\n</div>\n\n---\n\n[](LICENSE.md)\n[](https://pypi.org/project/doxysphinx/)\n[](https://pypi.org/project/doxysphinx/)\n[](https://github.com/boschglobal/doxysphinx/actions/workflows/ci.yml)\n[](https://github.com/boschglobal/doxysphinx/actions/workflows/cd.yml)\n\nDoxysphinx is a [Doxygen](https://doxygen.nl) and [Sphinx](https://sphinx-doc.org) integration tool.\n\nIt is an easy-to-use cli tool and typically runs right after Doxygen generation.\nIt reuses the Doxygen generated HTML output and integrates it into Sphinx document generation.\nWith this, Doxysphinx supports all known Doxygen features and at the same time integrates well with the Sphinx output (for example, Sphinx-Themes, search etc.).\nDoxysphinx, also supports [restructured text (rST) annotations](https://github.com/boschglobal/doxysphinx/blob/main/docs/using_rst_in_doxygen.md) within C++ files.\n\nInternally, Doxysphinx creates an rST file for each (Doxygen) HTML file and includes the HTML using `.. raw:: html` directive.\nLater Sphinx picks up these rST files and creates an integrated documentation.\n\nCheck out Doxysphinx alternatives [here](https://github.com/boschglobal/doxysphinx/blob/main/docs/alternatives.md).\n\n## Links\n\n\ud83d\udcda [Doxysphinx Overview](https://boschglobal.github.io/doxysphinx)\n\n\ud83d\ude80 [Getting Started](https://boschglobal.github.io/doxysphinx/docs/getting_started.html)\n\n\ud83d\udcbb [Developer Quickstart](https://boschglobal.github.io/doxysphinx/docs/dev_guide.html)\n\n\ud83e\udd16 [Releases](https://github.com/boschglobal/doxysphinx/releases)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Integrates doxygen html documentation with sphinx.",
"version": "3.3.8",
"project_urls": {
"Documentation": "https://boschglobal.github.io/doxysphinx/",
"Homepage": "https://github.com/boschglobal/doxysphinx",
"Repository": "https://github.com/boschglobal/doxysphinx"
},
"split_keywords": [
"dac",
" docs-as-code",
" doxygen",
" sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31c2e5dfe7f17404081723b82f2945d40a0559a9f353d749dc61bdbae14cdd5e",
"md5": "9ad7d18a1df788be7674398fc0c93abf",
"sha256": "ca606355ca7dbc8a343085bb5e16c3a7461b7d5fdc4055578ae911ea6233b6e0"
},
"downloads": -1,
"filename": "doxysphinx-3.3.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ad7d18a1df788be7674398fc0c93abf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 41805,
"upload_time": "2024-04-30T06:05:43",
"upload_time_iso_8601": "2024-04-30T06:05:43.990551Z",
"url": "https://files.pythonhosted.org/packages/31/c2/e5dfe7f17404081723b82f2945d40a0559a9f353d749dc61bdbae14cdd5e/doxysphinx-3.3.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "84531079743ab3478caac5aa2a01acc0b19c3bf82156c71f50b71b08df85b104",
"md5": "1c9277ffa052a96ced88a6099666c50e",
"sha256": "1885cff8058ce24c0c3b3e57db8bbd24f3319e521e3cd14503aa753df7f1dafd"
},
"downloads": -1,
"filename": "doxysphinx-3.3.8.tar.gz",
"has_sig": false,
"md5_digest": "1c9277ffa052a96ced88a6099666c50e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 34540,
"upload_time": "2024-04-30T06:05:45",
"upload_time_iso_8601": "2024-04-30T06:05:45.932724Z",
"url": "https://files.pythonhosted.org/packages/84/53/1079743ab3478caac5aa2a01acc0b19c3bf82156c71f50b71b08df85b104/doxysphinx-3.3.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 06:05:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "boschglobal",
"github_project": "doxysphinx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "doxysphinx"
}
JSON
