ConfD User Community

YANG model documentation generator


#1

Hello. Does anyone know of any documentation generators which will process a YANG model and produce formatted documentation output?

I suppose I want a doxygen-like tool but for YANG models.


#2

I do not know of any doxygen-like document generator. The only thing I can think of now is to take a look at pyang (-f FORMAT option). It is possible to write own pyang plugin, which can generate documentation as you need.


#3

Thank you for your answer


#4

Perhaps the IETF way of documenting their standard YANG models is a good reference. See for example the ACL one from March 2019 https://tools.ietf.org/html/rfc8519

Main components are always the YANG model itself and a YANG tree diagram that you can generate using:

$ pyang -f tree my-model.yang

or ConfD’s

$ yanger -f tree my-model.yang

The RFC for the YANG tree diagram can be found here: https://tools.ietf.org/html/rfc8340