A sphinx domain for semi-automatically documenting VHDL
This extension for Sphinx allows you to keep your documentation in code and automatically draw it out into your main documentation using just few simple directives.
You can see the detailed documentation at https://cesnet.github.io/sphinx-vhdl/, or build it yourself (running make html
while in the doc
directory and having sphinx
installed should be sufficient)
The python package must be installed with
pip3 install sphinx-vhdl
The usage of this extension requires Python >= 3.6 and Sphinx >= 4.0.0.
In your sphinx conf.py
file add
extensions = ['sphinxvhdl.vhdl']
vhdl_autodoc_source_path = 'path/to/your/vhdl/sources/root'
- Original: Jindřich Dítě, [email protected]
- Backup: Jakub Cabal, [email protected]
- Backup: Daniel Kříž, [email protected]