search

TerosTechnology / vscode-terosHDL

VHDL and Verilog/SV IDE: state machine viewer, linter, documentation, snippets... and more!
https://terostechnology.github.io/terosHDLdoc/
GNU General Public License v3.0
551 stars 46 forks source link

Custom template for documenter #391

Open elpollodiablo84 opened 1 year ago

elpollodiablo84 commented 1 year ago

(I proposed this idea briefly in #387, but I suppose it's better to create a new issue to optimize tracking)

I think that the documenter functionality has a lot of potential in this project, and I have an idea for an update that I don't think need a lot of work. I'm talking about integrating a custom template framework like Jinja to customize every part of the output documentation. Every organization/company has some specific rules about work-related documents, like format specific properties (footer, header, logos, ...) or language specific ones (right now we have only English/Russian in Teros): with Jinja you can "fill" a company template of a document with all your code information extracted somehow from your project. Since I think Teros is in the middle of an important backend update, I understand that this is not a priority right now, but a simple enhancement that can be implemented when there's some time is just to add the possibility to export the parsed code used to create the markdown/html documentation in a dictionary-like format like json or yaml. That is enough for the user to generate documentation through Jinja. This is clearly my idea of an enhancement for the project, so if this fall out of scope of Teros, feel free to scrap all of this obviously.

Anyway, thanks a lot for this project, I use it daily in my work environment and it's really a blessing!

qarlosalberto commented 1 year ago

It could be a very cool feature.