kamorrissey/mkdoxy

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

MkDoxy

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

Warning Extension is in development and few features are not working properly. More information in Known issues section and Issues page.

MkDoxy is based on matusnovak/doxybook

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

Online Demo and Demo Source

Features

• Easy to use: just add mkdoxy to your mkdocs.yml and config path to your project src folder.
• Code snippets: mkdoxy supports code snippets in your documentation. Just add ::: <project_name>.<command_name> to your markdown file and mkdoxy will generate code just in the place where you want it. Inspired from mkdocstrings.
• Multiple projects: mkdoxy supports multiple projects. You can add multiple source folders and generate documentation for all of them. For example, you can generate documentation for your C++ project and your Python project like in this example.
• Custom API documentation structure is allowed using Jinja2 templates. You can add your own templates and generate documentation in any structure you want.

Requirements

• python 3.8 or newer → sudo apt install python3
• Pip → sudo apt install python3-pip
• Doxygen → sudo apt install doxygen
• Git → sudo apt install git (optional)

Installation

Install using Python Pip: https://pypi.org/project/MkDoxy/

pip install mkdoxy

Or installation from source:

git clone https://github.com/JakubAndrysek/MkDoxy.git
cd mkdoxy
python setup.py install # for normal usage
pip install -e . # for development (source code changes are applied immediately)

Example usage

Set [PROJECT] according to your project names configured in mkdocs.yml.

1. Generate class with name `rb::MotorChangeBuilder`

```yaml
::: doxy.[PROJECT].Class
  name: rb::MotorChangeBuilder

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

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

3. Generate function with name readUltra (bool async)

::: doxy.[PROJECT].Function
  name: readUltra (bool async)

4. Generate code snippet from file RBCXLeds.cpp

::: doxy.[PROJECT].Code
  file: RBCXLeds.cpp
  start: 21
  end: 35

Mkdocs.yml configuration

Click to expand

plugins:
  - mkdoxy:
      projects:
        apiProject1: # name of project must be alphanumeric + numbers (without spaces)
          src-dirs: path/to/src/project1
          full-doc: True
          doxy-cfg:
            FILE_PATTERNS: "*.cpp *.h*"
            EXAMPLE_PATH: examples
            RECURSIVE: True
        apiProject2:
          src-dirs: path/to/src/project2
          full-doc: True
          template-dir: path/to/userDefined/templates # optional (default is mkdoxy/templates) - custom template will replace default template
          # Example of custom template: https://mkdoxy-demo.kubaandrysek.cz/esp/annotated/
          doxy-cfg:
            FILE_PATTERNS: "*.py"
            EXAMPLE_PATH: ""
            RECURSIVE: True
            OPTIMIZE_OUTPUT_JAVA: True
            JAVADOC_AUTOBRIEF: True
            EXTRACT_ALL: True
        predefinedProject3:
          src-dirs: path/to/src/project3
          full-doc: False
          doxy-cfg:
            PREDEFINED: __cplusplus # example there: https://github.com/kuba2k2/libretuya/blob/master/mkdocs.yml
            CASE_SENSE_NAMES: NO
...
nav:
  - Home: 'index.md'
  - API:
      - Project 1:
          - 'Links': 'apiProject1/links.md'
          - 'Classes':
              - 'Class List': 'apiProject1/annotated.md'
              - 'Class Index': 'apiProject1/classes.md'
              - 'Class Hierarchy': 'apiProject1/hierarchy.md'
              - 'Class Members': 'apiProject1/class_members.md'
              - 'Class Member Functions': 'apiProject1/class_member_functions.md'
              - 'Class Member Variables': 'apiProject1/class_member_variables.md'
              - 'Class Member Typedefs': 'apiProject1/class_member_typedefs.md'
              - 'Class Member Enumerations': 'apiProject1/class_member_enums.md'
          - 'Namespaces':
              - 'Namespace List': 'apiProject1/namespaces.md'
              - 'Namespace Members': 'apiProject1/namespace_members.md'
              - 'Namespace Member Functions': 'apiProject1/namespace_member_functions.md'
              - 'Namespace Member Variables': 'apiProject1/namespace_member_variables.md'
              - 'Namespace Member Typedefs': 'apiProject1/namespace_member_typedefs.md'
              - 'Namespace Member Enumerations': 'apiProject1/namespace_member_enums.md'
          - 'Functions': 'apiProject1/functions.md'
          - 'Variables': 'apiProject1/variables.md'
          - 'Macros': 'apiProject1/macros.md'
          - 'Files': 'apiProject1/files.md'
      - Project 2:
...

use_directory_urls: true # (optional) for better links without .html extension

Known issues

1. Doxygen is not able to parse Python code.
   • Solution: Use OPTIMIZE_OUTPUT_JAVA: True and JAVADOC_AUTOBRIEF: True in doxy-cfg section of mkdocs.yml.
2. Relative links from snippets are not working properly.
   • In some cases, relative links are not working properly.
   • For example link on test page - ClassList under Class rb::MotorChangeBuilder is not working.

Changes

• v1.0.0 - 2023-01-24
  • Initial release
• v1.0.3 - 2023-03-21
  • Fix: Hash function support subfolders
• v1.0.5 - 2023-04-01
  • Add support for custom templates
• v1.0.6 - 2023-04-01
  • Add support disable plugin using environment variable

Disabling the plugin

You can use the enabled option to optionally disable this plugin. A possible use case is local development where you might want faster build times.

plugins:
  - mkdoxy:
      enabled: !ENV [ENABLE_MKDOXY, True]
      ...

This will disable the plugin if the ENABLE_MKDOXY environment variable is not set or is set to False. Inspirated by mkdocs-simple-hooks

export ENABLE_MKDOXY=False
mkdocs serve

License

This project is licensed under the terms of the MIT license