search

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
59 stars 16 forks source link

mkdoxy custom output path #108

Open nihalshah-dev opened 1 month ago

nihalshah-dev commented 1 month ago

Hello @JakubAndrysek , Thanks for this wonderful plugin. I am trying to render output of mkdoxy through dev container. I want to store and see the output files in a custom folder, tried adding save-api function but somehow i am not able to see the folder.

My mkdoxy config looks like this -

image

image

DOXYFILE --> image

Surprisingly, when i do mkdocs build. 1) Output html files are stored in site/doxygen-demo 2) Output markdown files are stored in site/assets/.doxy/doxygen-demo/doxygen-demo

FYI doxygen-demo == <NAME-OF-PROJECT>

Also If even after this works, is the addition of output files in nav section in mkdocs.yml a manual process? image

will the following work in my case? 

nav:
- 'Doxygen':
  - 'Doxygen-Demo': 'doxygen-demo/**'

Thanks!! Any ideas to resolve this?

nihalshah-dev commented 4 weeks ago

Hello @JakubAndrysek If you have some time, could you please take a look at it? Appreciate any feedback. Thanks!

JakubAndrysek commented 3 weeks ago

Hi, sorry for the delay; I didn't have time for my open-source project.

I have tested https://github.com/JakubAndrysek/MkDoxy-demo project that contains save-api: .mkdoxy config in this file.

After installing dependencies, everything works perfectly. Try to run this tested project in your environment.

save-api

Important note - The save-api configured folder is created in the same location as you start the script (usually the same where you have the mkdocs.yml file, if I remember correctly.

image

Please try it without a custom doxygen folder - it is a new feature and might contain unexpected problems. Try to move the configuration to the mkdocs mkdocs.yml - example

JakubAndrysek commented 3 weeks ago

You have to configure the nav output by yourself as you mentioned in the image before.

nav:
- 'Doxygen':
  - 'Doxygen-Demo': 'doxygen-demo/**'

This won`t export the output as you want.

Automatically generate NAV menu

This is not supported yet - https://github.com/JakubAndrysek/MkDoxy/discussions/40

nihalshah-dev commented 3 weeks ago

Thank you so much @JakubAndrysek for the response. I'll try following what you suggested. I hope it works 🤞, if not I'll have to get back to you again 😀