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
	debug
	doxygen
	generatorBase

Public Static Attributes

Type	Name
tuple	config_project = = (
("src-dirs", config_options.Type(str)),
("full-doc", config_options.Type(bool, default=True)),
("debug", config_options.Type(bool, default=False)),
# ('ignore-errors', config_options.Type(bool, default=False)),
("doxy-cfg", config_options.Type(dict, default={}, required=False)),
("doxy-cfg-file", config_options.Type(str, default="", required=False)),
("template-dir", config_options.Type(str, default="", required=False)),
)
tuple	config_scheme = = (
("projects", config_options.Type(dict, default={})),
("full-doc", config_options.Type(bool, default=True)),
("debug", config_options.Type(bool, default=False)),
("ignore-errors", config_options.Type(bool, default=False)),
("save-api", config_options.Type(str, default="")),
("enabled", config_options.Type(bool, default=True)),
(
"doxygen-bin-path",
config_options.Type(str, default="doxygen", required=False),
),
)

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.

Public Attributes Documentation

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

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.

---

---

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