Skip to content

About

A Sphinx domain providing VHDL language support.

Topics

Resources

Stars

21 stars

Watchers

6 watching

Forks

Repository files navigation

Sourcecode on GitHub Sourcecode License Documentation Documentation License Gitter
PyPI PyPI - Status PyPI - Python Version
GitHub Workflow - Build and Test Status Libraries.io status for latest release Codacy - Quality Codacy - Coverage Codecov - Branch Coverage

VHDLDomain

A Sphinx domain providing VHDL language support.

Important

VHDLDomain requires Python 3.12 or newer, because it requires Sphinx 9.1 and Sphinx 9.1 does.

Main Goals

This sphinx extension adds a new language domain to Sphinx. It allows the documentation of VHDL source files.

Use Cases

  • Partial or fully automated documentation of VHDL designs.

Contributors

License

This Python package (source code) is licensed under Apache License 2.0.
The accompanying documentation is licensed under Creative Commons - Attribution 4.0 (CC-BY 4.0).
Content of other projects - the StopWatch example design from PLC2/Solution-StopWatch (MIT) - is listed with its license in NOTICE.md.


SPDX-License-Identifier: Apache-2.0

About

A Sphinx domain providing VHDL language support.

Topics

Resources

Stars

21 stars

Watchers

6 watching

Forks

Releases

Used by

Contributors

Languages