A Sphinx domain and autodocumenter for VHDL
Project description
Sphinx-vhdl
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)
Usage
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.
Configuration
In your sphinx conf.py
file add
extensions = ['sphinxvhdl.vhdl']
vhdl_autodoc_source_path = 'path/to/your/vhdl/sources/root'
Repository maintainer
- Jakub Cabal, cabal@cesnet.cz
- Vladislav Válek, valekv@cesnet.cz
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx_vhdl-0.1.6.tar.gz
(9.3 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_vhdl-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | babdde9ef606ec7f3d43a7cc11be61b3e899424d90be0a99617a53aef333c59e |
|
MD5 | 700ff735faa57b2e20e80fec0274b93b |
|
BLAKE2b-256 | dafca6c33c55fdfb6af6d3b4a04d49eea436603de44757f34770b2a346d2945f |