Metadata-Version: 2.1
Name: sphinx-vhdl
Version: 0.1.4
Summary: A Sphinx domain and autodocumenter for VHDL
Author: CESNET z.s.p.o.
Author-email: danielkriz@cesnet.cz
License: BSD-3-Clause
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation :: Sphinx
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Plugins
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Sphinx-vhdl

[![PyPI](https://img.shields.io/pypi/v/sphinx-vhdl)](https://pypi.org/project/sphinx-vhdl/)
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/CESNET/sphinx-vhdl/documentation?label=documentation)](https://cesnet.github.io/sphinx-vhdl/)

> A [sphinx](https://www.sphinx-doc.org/) 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
```shell
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

```python
extensions = ['sphinxvhdl.vhdl']
vhdl_autodoc_source_path = 'path/to/your/vhdl/sources/root'
```

## Repository maintainer

- Original: Jindřich Dítě, 230810@vut.cz
- Backup: Jakub Cabal, cabal@cesnet.cz
- Backup: Daniel Kříž, danielkriz@cesnet.cz
