Skip to content

Class mkdoxy::plugin::MkDoxy

ClassList > mkdoxy > plugin > MkDoxy

MkDocs plugin for generating documentation from Doxygen XML files.

Inherits the following classes: BasePlugin

Public Attributes

Type Name
config_project
debug
doxygen
generatorBase

Public Static Attributes

Type Name
tuple config_project = /* multi line expression */
tuple config_scheme = /* multi line expression */

Public Functions

Type Name
bool is_enabled (self self)
Checks if the plugin is enabled.
files.Files on_files (self self, files.Files files, base.Config config)
Called after files have been gathered by MkDocs.
str on_page_markdown (self self, str markdown, pages.Page page, base.Config config, files.Files files)
Generate snippets and append them to the markdown.

Protected Static Attributes

Type Name
dict _IMAGE_EXTENSIONS = {".png", ".jpg", ".jpeg", ".gif", ".bmp", ".svg", ".webp"}

Protected Functions

Type Name
list[PurePath] _copy_image_assets (self self, Path source_xml_dir, Path destination_dir, *set image_names, Callable check_collision, None]|None check_collision=None)

Public Attributes Documentation

variable config_project [2/2]

mkdoxy.plugin.MkDoxy::config_project;

variable debug

mkdoxy.plugin.MkDoxy::debug;

variable doxygen

mkdoxy.plugin.MkDoxy::doxygen;

variable generatorBase

mkdoxy.plugin.MkDoxy::generatorBase;

Public Static Attributes Documentation

variable config_project [1/2]

tuple mkdoxy.plugin.MkDoxy::config_project;

variable config_scheme

tuple mkdoxy.plugin.MkDoxy::config_scheme;

Public Functions Documentation

function is_enabled

Checks if the plugin is enabled.

bool mkdoxy::plugin::MkDoxy::is_enabled (
    self self
) 

Returns:

(bool) True if the plugin is enabled.


function on_files

Called after files have been gathered by MkDocs.

files.Files mkdoxy::plugin::MkDoxy::on_files (
    self self,
    files.Files files,
    base.Config config
) 

Parameters:

  • files (Files) The files gathered by MkDocs.
  • config (Config) The global configuration object.
Returns:

(Files) The files gathered by MkDocs.


function on_page_markdown

Generate snippets and append them to the markdown.

str mkdoxy::plugin::MkDoxy::on_page_markdown (
    self self,
    str markdown,
    pages.Page page,
    base.Config config,
    files.Files files
) 

Parameters:

  • markdown (str): The markdown.
  • page (Page): The MkDocs page.
  • config (Config): The MkDocs config.
  • files (Files): The MkDocs files.
Returns:

(str) The markdown.


Protected Static Attributes Documentation

variable _IMAGE_EXTENSIONS

dict mkdoxy.plugin.MkDoxy::_IMAGE_EXTENSIONS;

Protected Functions Documentation

function _copy_image_assets

list[PurePath] mkdoxy::plugin::MkDoxy::_copy_image_assets (
    self self,
    Path source_xml_dir,
    Path destination_dir,
    *set image_names,
    Callable check_collision,
    None]|None check_collision=None
) 


The documentation for this class was generated from the following file mkdoxy/plugin.py