vhdl-style-guide/docs/api.rst

23 lines
364 B
ReStructuredText

API
---
VSG was written to be included in other tools.
The command line script provides one means of using VSG.
It operates through an API.
Use the following module when incorporating VSG into another program:
.. toctree::
vsg.vhdlFile
vsg.rule_list
Use the following modules when writing rules:
.. toctree::
vsg.check
vsg.fix
vsg.utilities