From 166b95b42be334274ee10c0c204fd963e6a14367 Mon Sep 17 00:00:00 2001 From: Jakub Andrysek Date: Fri, 19 Apr 2024 11:09:34 +0200 Subject: [PATCH] Update Doxygen configuration in advanced.md --- docs/usage/advanced.md | 14 -------------- docs/usage/index.md | 34 ++++++++++++++++++++++++++++++---- 2 files changed, 30 insertions(+), 18 deletions(-) diff --git a/docs/usage/advanced.md b/docs/usage/advanced.md index d4ec5a71..f08deb9a 100644 --- a/docs/usage/advanced.md +++ b/docs/usage/advanced.md @@ -35,17 +35,3 @@ plugins: doxygen-bin-path: /path/to/doxygen ... ``` - -## Configure custom Doxygen configuration file -If you want to use a standard Doxygen configuration file, you can specify the path to the file using the `doxygen-config` option in the plugin configuration. - -```yaml hl_lines="6" -plugins: - - mkdoxy: - projects: - myProjectCpp: - src-dirs: ... - doxy-cfg-file: path/to/Doxyfile # relative path to the Doxygen configuration file (relative to the mkdocs.yml file) - doxy-cfg: # standard doxygen configuration (key: value) - FILE_PATTERNS: ... # other configuration options - merge (this will override the configuration from the Doxyfile) -``` diff --git a/docs/usage/index.md b/docs/usage/index.md index 059bc450..d395cc8f 100644 --- a/docs/usage/index.md +++ b/docs/usage/index.md @@ -37,7 +37,7 @@ The name of the project must be alphanumeric + numbers (without spaces). The name of the project is used to identify the project in the snippet tags. ??? abstract "Configure multiple projects" - ```yaml + ```yaml hl_lines="4-5 7-8 10-11" plugins: - mkdoxy: projects: @@ -58,8 +58,8 @@ Custom templates can be used to change the appearance of the generated documenta Each custom template file will replace the default template file. So you do not have to create a custom template for the whole documentation, but only for the parts you want to change. -??? abstract "Configure multiple projects" - ```yaml +??? abstract "Custom Jinja templates" + ```yaml hl_lines="6" plugins: - mkdoxy: projects: @@ -87,10 +87,11 @@ The configuration is merged with the default configuration. "GENERATE_LATEX": "NO", # do not generate LaTeX files ``` + Doxygen configuration options: [www.doxygen.nl/manual/config.html](https://www.doxygen.nl/manual/config.html) ??? abstract "Custom Doxygen configuration - override default configuration" - ```yaml + ```yaml hl_lines="7-13" plugins: - mkdoxy: projects: @@ -107,6 +108,31 @@ Doxygen configuration options: [www.doxygen.nl/manual/config.html](https://www.d ... ``` +## Configure custom Doxygen configuration file +If you want to use a standard `Doxygen` configuration file, you can specify the path to the file using the `doxygen-config` option in the plugin configuration. + +??? abstract "Add custom Doxygen configuration file" + ```yaml hl_lines="6" + plugins: + - mkdoxy: + projects: + myProjectCpp: + src-dirs: ... + doxy-cfg-file: path/to/Doxyfile # relative path to the Doxygen configuration file (relative to the mkdocs.yml file) + doxy-cfg: # standard doxygen configuration (key: value) + FILE_PATTERNS: ... # other configuration options - merge (this will override the configuration from the Doxyfile) + ``` + + ??? example "How is it implemented?" + +::: doxy.mkdoxyApi.code +file: doxyrun.py +start: 64 +end: 115 +indent_level: 8 + + + ## Advanced configuration