Any "bridge" between Documenter.jl and YAML.jl in order to document a YAML file?

General Usage
, ,
1

Ok, I have chosen YAML for the settings of my model.

Is there a way I can format the comments in YAML in a certain way in order to document the settings, parse these special comments and let them end up in a make_doc Documenter workflow together with the rest of the documentation of my package ?

Or alternatively embed the yaml file as a separate page on my package documentation ?

2

Seems like maybe a job for Literate.jl? It’s mainly meant for Julia files, but if you don’t actually try to execute it, then it might be possible to also make it work for other languages.

1 Like