MkDoxy

https://jakubandrysek.github.io/MkDoxy/

Admin

MkDoxy is a plugin for MkDocs that generates API documentation from Doxygen comments and code...

Tokens:569

Snippets:11

Trust Score:9.7

Update:4 months ago

Show doc for...

Tokens:

Raw

### Install MkDoxy from Source

Source: https://jakubandrysek.github.io/MkDoxy

Install MkDoxy directly from its GitHub repository.

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

```

--------------------------------

### Install MkDoxy using pip

Source: https://jakubandrysek.github.io/MkDoxy

Install the MkDoxy plugin from PyPI using pip.

```bash
pip install mkdoxy

```

--------------------------------

### Install MkDoxy Development Version

Source: https://jakubandrysek.github.io/MkDoxy

Install the development version of MkDoxy with all dependencies.

```bash
python -m pip install mkdoxy ".[dev]"

```

--------------------------------

### Configure MkDocs with MkDoxy

Source: https://jakubandrysek.github.io/MkDoxy

Example configuration for MkDocs using the MkDoxy plugin, specifying project source directories and Doxygen settings.

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


```

Tokens:

Raw