https://github.com/cesnet/sphinx-vhdl

https://github.com/cesnet/sphinx-vhdl

documentation-generator fpga liberouter sphinx sphinx-extension vhdl

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/cesnet/sphinx-vhdl
• Owner: CESNET
• License: bsd-3-clause
• Created: 2021-07-28T13:51:39.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-04T13:13:17.000Z (10 months ago)
• Last Synced: 2025-07-09T05:44:09.718Z (7 months ago)
• Topics: documentation-generator, fpga, liberouter, sphinx, sphinx-extension, vhdl
• Language: Python
• Homepage: https://cesnet.github.io/sphinx-vhdl/
• Size: 5.37 MB
• Stars: 23
• Watchers: 9
• Forks: 9
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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/actions/workflow/status/CESNET/sphinx-vhdl/.github/workflows/doc.yml)](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` while in the `doc` directory and having `sphinx` + `sphinx_rtd_theme` installed should be sufficient)

## Usage

The python package must be installed with

```shell

pip3 install sphinx-vhdl

```

This extension requires Python >= 3.8 and Sphinx >= 6.0.0.

*Note that your documentation may use multiple sphinx extensions or an alternative theme (such as `sphinx_rtd_theme`), which you must also have installed.*

## Configuration

In your sphinx `conf.py` file add

```python

extensions = ['sphinxvhdl.vhdl']

vhdl_autodoc_source_path = 'path/to/your/vhdl/sources/root'

```

## Where is the SPHINX-VHDL extension used?

- [NDK-FPGA by CESNET](https://github.com/CESNET/ndk-fpga)

- *Do you use SPHINX-VHDL in your public VHDL repository? Please add a link to this list!*

## Repository maintainer

- Jakub Cabal, cabal@cesnet.cz

- Vladislav Válek, valekv@cesnet.cz