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

No apparent documentation for templating feature #54

Closed kamorrissey closed 1 year ago

kamorrissey commented 1 year ago

We would like to use the templating feature but cannot find documentation for it. I understand Jinja2 is used, but don't know the specifics like what template files are used for what. For example, I don't see a template for documenting a specific class.

Could you rough in some documentation on using templates?

JakubAndrysek commented 1 year ago

Of course, it's in my immediate future plans.

Basically, I am using these templates for rendering. If you would like to customize class render, you have to copy mkdoxy/templates/member.jinja2 to your custom dir folder, add this folder to mkdocs.yaml using template-dir: path/to/userDefined/templates. This one template will replace only the template file with the same name.

Right now the template configuration is defined only in the source code.

Example usage:

I`m working on better documentation and it will be added in a few days.

kamorrissey commented 1 year ago

I would be glad to help review this, maybe even do some writing if you can help me understand things.