mkdoxy 1.0.0

MkDoxy -> MkDocs + Doxygen. Easy documentation generator with code snippets.

MkDoxy

MkDoxy -> MkDocs + Doxygen. Easy documentation with code snippets.

Based on matusnovak/doxybook

This python tool is extension for MkDocs. Extension will take your programme source code and runs Doxygen. Than converts exported XML into markdown and create new folder with full generated documentation. Next usage is by snippets inside documentation markdown.

Example usage

1. Generate class with name rb::MotorChangeBuilder

::: doxy.Class
    name: rb::MotorChangeBuilder

2. Generate method brake (MotorId id, uint16_t brakingPower) from class with name rb::MotorChangeBuilderA

::: doxy.Class.Method
    name: rb::MotorChangeBuilder
    method: brake (MotorId id, uint16_t brakingPower)

3. Generate function with name readUltra (bool async)

::: doxy.Function
    name: readUltra (bool async)

4. Generate code snippet from file RBCXLeds.cpp

::: doxy.Code
    file: RBCXLeds.cpp
    start: 21
    end: 35

Requirements

Apt

• python 3.6 or newer -> sudo apt install python3
• Pip -> sudo apt install python3-pip
• Git -> sudo apt install git
• Doxygen -> sudo apt install doxygen

Pip

• Jinja2 -> pip install jinja2
• Mkdocs -> pip install mkdocs
• ruamel.yaml -> pip install ruamel.yaml

Optional:

• mkdocs-material -> pip install mkdocs-material

Installation

Install using Python Pip: https://pypi.org/project/mkdocs-doxygen-snippets-plugin/

pip install mkdocs-doxygen-snippets-plugin

Or Install manually:

git clone https://github.com/JakubAndrysek/mkdocs-doxygen-snippets-plugin.git
cd mkdocs-doxygen-snippets-plugin
python setup.py install

What files are generated?

This tool was designed to copy the file naming and structure of Doxygen html output. The naming of the files is identical except tiny changes with Class/Variable/enumeration Index pages.

All classes, namespaces, structures, and interfaces are generated, including the following additional files:

• Directories (e.g. dir_....md)
• Files with source code + file documentation (e.g. filename_8h.md)
• Markdown pages processed through doxygen, highly do not recommend using this! (e.g. md_src_....md)
• Members (e.g. class_xxx_yyy.md or namespace_xxx_yyy.md)
• Class List (e.g. annotated.md)
• Class Index (e.g. classes.md)
• Class Members (e.g. class_members.md, class_member_enums.md, class_member_functions.md, class_member_typedefs.md, class_member_variables.md)
• Class Hierarchy (.e.g hierarchy.md)
• Namespace List (e.g. namespaces.md)
• Namespace Members (e.g. namespace_members.md, namespace_member_enums.md, namespace_member_functions.md, namespace_member_typedefs.md, namespace_member_variables.md)
• Modules/groups (e.g. modules.md)
• Index page (if exists within Doxygen output as indexpage.xml) (e.g. index.md)
• Any additional pages generated by Doxygen such as bugs, todo, tests

See the example folder to see all files.

License

MIT License

Copyright (c) 2021 Kuba Andrýsek

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.