mkdoxy 1.1.2

MkDoxy → MkDocs + Doxygen = easy documentation generator with code snippets

MkDoxy

MkDoxy plugin for MkDocs generates API documentation based on Doxygen comments and code snippets in your markdown files.

Warning Extension is in development and few features are not working properly. More information in Discussions and Issues pages.

---

:material-home-edit: Online Demo and :simple-github: Demo source-code

---

Feature List - Installation - Quick start

Feature List

• Easy to use:: Just add mkdoxy to your mkdocs.yml and configure the path to your source code.
• Code snippets: Generate code snippets in place of your standard Markdown documentation.
• Multiple projects: Support for multiple projects in one documentation (e.g. C++ and Python).
• Multiple source directories: Configure multiple source directories in one project.
• Custom Jinja templates: Define custom Jinja templates for rendering Doxygen documentation.
• Custom Doxygen configuration: Specify custom Doxygen configuration for each project.

Installation

With pip:

pip install mkdoxy

Install from source - development version:

pip install git+https://github.com/JakubAndrysek/MkDoxy.git

Quick start

mkdocs.yml:

site_name: "My 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

Do You Enjoy MkDoxy or Does It Save You Time?

Then definitely consider:

• supporting me on GitHub Sponsors:

License

This project is licensed under the terms of the MIT license