JakubAndrysek / MkDoxy

📖 Automatically generates API documentation for your project based on Doxygen comments and code snippets in your markdown files.
https://mkdoxy.kubaandrysek.cz/
MIT License
60 stars 16 forks source link

Add an option `doxygen-bin-path` to specify the path to `doxygen`. #58

Closed thb-sb closed 1 year ago

thb-sb commented 1 year ago

This commit introduces an option to let the user specify the filepath to the doxygen binary.

This option is called doxygen-bin-path and can be set in the mkdocs.yml under the mkdoxy section.

The following snippet is an example of how to use this new option:

site_name: My Doc
…

plugins:
  - mkdoxy:
    enabled: !ENV [ENABLE_MKDOXY, True]
    doxygen-bin-path: path/to/doxygen/build/bin/doxygen
    projects:
      mkdoxyApi:
        src-dirs: mkdoxy
        …

If not specified, the default value will obviously be doxygen.

JakubAndrysek commented 1 year ago

Marged using the command line