Dependencies viewer

The dependencies viewer can create a dependencie graph of the given files. Aditionally it’s possible to export the documentation of all the provided files along with the dependencies graph and an index linking all the generated documentaion files.

Important

Requirements!

To be able to use this functionality is necesary to have Python3 configured in TerosHDL More info in the configuration section

Usage instructions

  1. Open the command palette Ctrl+Shift+P and select Open dependencies viewer

../_images/sample_dependencies_select.png
  1. Add a HDL files to the viewer (you can mix verilog and VHDL).

../_images/sample_dependencies_add.png
  1. TerosHDL will generate the dependencies graph:

../_images/sample_dependencies_viewer.png
  1. You can reset your viewer:

../_images/sample_dependencies_clear.png
  1. You can generate the indexed Markdown documentation for all the files.

../_images/sample_dependencies_documentation_md.png
  1. And the indexed HTML documentation.

../_images/sample_dependencies_documentation_html.png
  1. Result in HTML format:

../_images/project_doc.gif