# MkDoxy
**[MkDoxy](https://mkdoxy.kubaandrysek.cz/)** plugin for **[MkDocs](https://www.mkdocs.org/)** generates API documentation based on **[Doxygen](https://www.doxygen.nl)** comments and **[code snippets](/intro)** in your markdown files.
<p align="center">
<a href="https://hits.seeyoufarm.com"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FJakubAndrysek%2FMkDoxy&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true"/></a>
<a href="https://github.com/JakubAndrysek/MkDoxy/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/JakubAndrysek/MkDoxy?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/MkDoxy/releases" target="_blank"><img src="https://img.shields.io/github/v/release/JakubAndrysek/MkDoxy?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/MkDoxy/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/JakubAndrysek/MkDoxy?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/MkDoxy/forks" target="_blank"><img src="https://img.shields.io/github/forks/JakubAndrysek/MkDoxy?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/MkDoxy/issues" target="_blank"><img src="https://img.shields.io/github/issues/JakubAndrysek/MkDoxy?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/MkDoxy/discussions" target="_blank"><img src="https://img.shields.io/github/discussions/JakubAndrysek/MkDoxy?style=flat-square"></a>
<a href="https://www.pepy.tech/projects/mkdoxy" target="_blank"><img src="https://static.pepy.tech/badge/mkdoxy"></a>
</p>
> **Warning**
> **Extension is in development**, and a few features are not working properly.
> More information in [Discussions](https://github.com/JakubAndrysek/MkDoxy/discussions) and [Issues](https://github.com/JakubAndrysek/MkDoxy/issues) pages.
---
## [:material-home-edit: Online Demo](https://jakubandrysek.github.io/MkDoxy-demo/) and [:simple-github: Demo source-code ](https://github.com/JakubAndrysek/MkDoxy-demo)
---
**[Feature List](#feature-list)** - **[Installation](#installation)** - **[Quick start](#quick-start)**
## Feature List
- **[Easy to use](#quick-start):**: Just add `mkdoxy` to your `mkdocs.yml` and configure the path to your source code.
- **[Code snippets](./snippets/index.md)**: Generate code snippets in place of your standard Markdown documentation.
- **[Multiple projects](./usage/index.md#multiple-projects)**: Support for multiple projects in one documentation (e.g. C++ and Python).
- **[Multiple source directories](./usage/index.md#multiple-source-directories)**: Configure multiple source directories in one project.
- **[Custom Jinja templates](./usage/index.md#custom-jinja-templates)**: Define custom Jinja templates for rendering Doxygen documentation.
- **[Custom Doxygen configuration](./usage/index.md#custom-doxygen-configuration)**: Specify custom Doxygen configuration for each project.
## Installation
Install the plugin using pip from [PyPI](https://pypi.org/project/mkdoxy/):
```bash
pip install mkdoxy
```
Development version with all dependencies:
```bash
python -m pip install mkdoxy ".[dev]"
```
Install from source:
```bash
pip install git+https://github.com/JakubAndrysek/MkDoxy.git
```
## Quick start
`mkdocs.yml`:
```yaml
site_name: "My MkDoxy documentation"
theme:
name: material
plugins:
- search
- mkdoxy:
projects:
myProjectCpp: # name of project must be alphanumeric + numbers (without spaces)
src-dirs: path/to/src/project1 # path to source code (support multiple paths separated by space) => INPUT
full-doc: True # if you want to generate full documentation
doxy-cfg: # standard doxygen configuration (key: value)
FILE_PATTERNS: "*.cpp *.h*" # specify file patterns to filter out
RECURSIVE: True # recursive search in source directories
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you want to change.
## Do You Enjoy MkDoxy or Does It Save You Time?
Then definitely consider:
- supporting me on GitHub Sponsors: [](https://github.com/sponsors/jakubandrysek)
## License
This project is licensed under the terms of the [MIT license](https://github.com/JakubAndrysek/MkDoxy/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/JakubAndrysek/MkDoxy",
"name": "mkdoxy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "mkdoxy, python, open-source, documentation, mkdocs, doxygen, multilanguage, code-snippets, code, snippets, documentation-generator",
"author": "Jakub Andr\u00fdsek",
"author_email": "email@kubaandrysek.cz",
"download_url": "https://files.pythonhosted.org/packages/24/88/e0d6b0c62703bdfe64922dca914e3604be17ac76f0ca16fc0dfeb683f705/mkdoxy-1.2.2.tar.gz",
"platform": null,
"description": "# MkDoxy\n\n**[MkDoxy](https://mkdoxy.kubaandrysek.cz/)** plugin for **[MkDocs](https://www.mkdocs.org/)** generates API documentation based on **[Doxygen](https://www.doxygen.nl)** comments and **[code snippets](/intro)** in your markdown files.\n\n<p align=\"center\">\n<a href=\"https://hits.seeyoufarm.com\"><img src=\"https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FJakubAndrysek%2FMkDoxy&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true\"/></a>\n<a href=\"https://github.com/JakubAndrysek/MkDoxy/blob/main/LICENSE\" target=\"_blank\"><img src=\"https://img.shields.io/github/license/JakubAndrysek/MkDoxy?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/MkDoxy/releases\" target=\"_blank\"><img src=\"https://img.shields.io/github/v/release/JakubAndrysek/MkDoxy?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/MkDoxy/stargazers\" target=\"_blank\"><img src=\"https://img.shields.io/github/stars/JakubAndrysek/MkDoxy?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/MkDoxy/forks\" target=\"_blank\"><img src=\"https://img.shields.io/github/forks/JakubAndrysek/MkDoxy?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/MkDoxy/issues\" target=\"_blank\"><img src=\"https://img.shields.io/github/issues/JakubAndrysek/MkDoxy?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/MkDoxy/discussions\" target=\"_blank\"><img src=\"https://img.shields.io/github/discussions/JakubAndrysek/MkDoxy?style=flat-square\"></a>\n<a href=\"https://www.pepy.tech/projects/mkdoxy\" target=\"_blank\"><img src=\"https://static.pepy.tech/badge/mkdoxy\"></a>\n</p>\n\n> **Warning**\n> **Extension is in development**, and a few features are not working properly.\n> More information in [Discussions](https://github.com/JakubAndrysek/MkDoxy/discussions) and [Issues](https://github.com/JakubAndrysek/MkDoxy/issues) pages.\n\n---\n\n## [:material-home-edit: Online Demo](https://jakubandrysek.github.io/MkDoxy-demo/) and [:simple-github: Demo source-code ](https://github.com/JakubAndrysek/MkDoxy-demo)\n\n---\n\n**[Feature List](#feature-list)** - **[Installation](#installation)** - **[Quick start](#quick-start)**\n\n## Feature List\n- **[Easy to use](#quick-start):**: Just add `mkdoxy` to your `mkdocs.yml` and configure the path to your source code.\n- **[Code snippets](./snippets/index.md)**: Generate code snippets in place of your standard Markdown documentation.\n- **[Multiple projects](./usage/index.md#multiple-projects)**: Support for multiple projects in one documentation (e.g. C++ and Python).\n- **[Multiple source directories](./usage/index.md#multiple-source-directories)**: Configure multiple source directories in one project.\n- **[Custom Jinja templates](./usage/index.md#custom-jinja-templates)**: Define custom Jinja templates for rendering Doxygen documentation.\n- **[Custom Doxygen configuration](./usage/index.md#custom-doxygen-configuration)**: Specify custom Doxygen configuration for each project.\n\n## Installation\nInstall the plugin using pip from [PyPI](https://pypi.org/project/mkdoxy/):\n\n```bash\npip install mkdoxy\n```\nDevelopment version with all dependencies:\n```bash\npython -m pip install mkdoxy \".[dev]\"\n```\n\nInstall from source:\n```bash\npip install git+https://github.com/JakubAndrysek/MkDoxy.git\n```\n\n## Quick start\n\n`mkdocs.yml`:\n```yaml\nsite_name: \"My MkDoxy documentation\"\n\ntheme:\n name: material\n\nplugins:\n - search\n - mkdoxy:\n projects:\n myProjectCpp: # name of project must be alphanumeric + numbers (without spaces)\n src-dirs: path/to/src/project1 # path to source code (support multiple paths separated by space) => INPUT\n full-doc: True # if you want to generate full documentation\n doxy-cfg: # standard doxygen configuration (key: value)\n FILE_PATTERNS: \"*.cpp *.h*\" # specify file patterns to filter out\n RECURSIVE: True # recursive search in source directories\n```\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you want to change.\n\n## Do You Enjoy MkDoxy or Does It Save You Time?\nThen definitely consider:\n\n- supporting me on GitHub Sponsors: [](https://github.com/sponsors/jakubandrysek)\n\n## License\n\nThis project is licensed under the terms of the [MIT license](https://github.com/JakubAndrysek/MkDoxy/blob/main/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDoxy \u2192 MkDocs + Doxygen = easy documentation generator with code snippets",
"version": "1.2.2",
"project_urls": {
"Documentation": "https://mkdoxy.kubaandrysek.cz/",
"Funding": "https://github.com/sponsors/jakubandrysek",
"Homepage": "https://github.com/JakubAndrysek/MkDoxy",
"Source": "https://github.com/JakubAndrysek/MkDoxy",
"Tracker": "https://github.com/JakubAndrysek/MkDoxy/issues"
},
"split_keywords": [
"mkdoxy",
" python",
" open-source",
" documentation",
" mkdocs",
" doxygen",
" multilanguage",
" code-snippets",
" code",
" snippets",
" documentation-generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3aa8418ad368b291016ef36fe4cddd6cc82e8b6a01a1ce5a25b1bf7b250b3cc5",
"md5": "caf9a7be4bcd07d3344ce8ea2b6f0a4a",
"sha256": "aebdf5e6a284de41caf37392215b5e4f8bc12ec0dca3ec5d1ce5670a1cdea0ba"
},
"downloads": -1,
"filename": "mkdoxy-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "caf9a7be4bcd07d3344ce8ea2b6f0a4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 43466,
"upload_time": "2024-04-19T09:27:29",
"upload_time_iso_8601": "2024-04-19T09:27:29.111745Z",
"url": "https://files.pythonhosted.org/packages/3a/a8/418ad368b291016ef36fe4cddd6cc82e8b6a01a1ce5a25b1bf7b250b3cc5/mkdoxy-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2488e0d6b0c62703bdfe64922dca914e3604be17ac76f0ca16fc0dfeb683f705",
"md5": "80d8be968943e0dd4197d4d9e91e4f51",
"sha256": "0b7a708b4748079f604319bdcba947c8182a360844cfaaeb012de069bb0cc94b"
},
"downloads": -1,
"filename": "mkdoxy-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "80d8be968943e0dd4197d4d9e91e4f51",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 36689,
"upload_time": "2024-04-19T09:27:31",
"upload_time_iso_8601": "2024-04-19T09:27:31.364427Z",
"url": "https://files.pythonhosted.org/packages/24/88/e0d6b0c62703bdfe64922dca914e3604be17ac76f0ca16fc0dfeb683f705/mkdoxy-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-19 09:27:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JakubAndrysek",
"github_project": "MkDoxy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "mkdocs",
"specs": []
}
],
"lcname": "mkdoxy"
}
JSON
