Metadata-Version: 2.4
Name: mkdocs-doxybook2
Version: 0.2.0
Summary: A Doxybook2 Helper Plugin for MkDocs documentations
Author-email: ACoderOrHacker <ACoderOrHacker@zohomail.com>
License: MIT
Project-URL: Homepage, https://github.com/ACoderOrHacker/mkdoxybook2
Project-URL: Bug Tracker, https://github.com/ACoderOrHacker/mkdoxybook2/issues
Keywords: mkdocs,doxygen,doxybook2,documentation
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Framework :: MkDocs
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.5.0
Dynamic: license-file

# Introduction

`mkdocs-doxybook2` is a MkDocs Plugin for doxygen output.
It uses `doxybook2` to convert Doxygen XML to Markdown files.

# Requirements

Before using it, [Doxygen](https://doxygen.nl) and `Doxybook2` are required. You should install them first.

> [!NOTE]
> The main repository of [Doxybook2](https://github.com/matusnovak/doxybook2) has been archived.
> For newer features, you can install [GeniusVentures/doxybook2](https://github.com/GeniusVentures/doxybook2).

# Usage

Add the plugin to your `mkdocs.yml` configuration:

```yaml
plugins:
  - mkdoxybook2
```

## Options

You can configure the plugin by adding options to the `mkdocs.yml` configuration:

```yaml
plugins:
  - mkdoxybook2:
      doxygen-path: # Optional, default to `doxygen`
      doxybook2-path: # Optional, default to `doxybook2`
      output-dir: # Optional, default to `mkdoxygen_output`
      projects: # Define projects to generate documentation for, see details below
      doxy-cfg: # Optional, global Doxygen configuration
      doxybook2-cfg: # Optional, global Doxybook2 configuration
```

| Option         | Description                                                                 |
| -------------- | --------------------------------------------------------------------------- |
| doxygen-path   | The path of Doxygen. Default to `doxygen`.                                  |
| doxybook2-path | The path of Doxybook2. Default to `doxybook2`.                              |
| output-dir     | The internal documentation output directory. Default to `mkdoxygen_output`. |
| projects       | Define projects to generate documentation for                               |
| doxy-cfg       | Optional, global Doxygen configuration.                                     |
| doxybook2-cfg  | Optional, global Doxybook2 configuration.                                   |

### Option `projects`

Add multiple projects to generate documentation for.
You can add projects with the following structure:

```yaml
projects:
  <name>:
    src-dirs: # Source directories to scan for documentation
    full-doc: True # Optional, generate full documentation
    output-dir: # Optional, output directory
    doxy-cfg: # Optional, Doxygen configuration
    doxybook2-cfg: # Optional, Doxybook2 configuration
```

`doxy-cfg` and `doxybook2-cfg` are optional, and will be merged with the global configuration. They have higher priority than global.

See default values at [mkdoxybook2/constants.py](https://github.com/ACoderOrHacker/mkdocs-doxybook2/blob/master/mkdoxybook2/constants.py)
