Metadata-Version: 2.4
Name: VHDLDomain
Version: 0.2.0
Summary: A Sphinx domain providing VHDL language support.
Home-page: https://GitHub.com/VHDL/VHDLDomain
Author: Patrick Lehmann
Author-email: Paebbels@gmail.com
License: Apache-2.0
Project-URL: Documentation, https://VHDL.GitHub.io/VHDLDomain
Project-URL: Source Code, https://GitHub.com/VHDL/VHDLDomain
Project-URL: Issue Tracker, https://GitHub.com/VHDL/VHDLDomain/issues
Keywords: Python3,VHDL,Sphinx,Sphinx Extension,Sphinx Domain,Documentation
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
Classifier: Framework :: Sphinx :: Domain
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Classifier: Topic :: Software Development :: Documentation
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
License-File: NOTICE.md
Requires-Dist: pyTooling.Sphinx~=1.0
Requires-Dist: pyTooling<11.0,>=10.1.1
Requires-Dist: sphinx>=9.1.1
Requires-Dist: pyVHDLModel~=0.40.0
Provides-Extra: doc
Requires-Dist: sphinx>=9.1.1; extra == "doc"
Requires-Dist: sphinx_design~=0.7.0; extra == "doc"
Requires-Dist: pyVHDLModel~=0.40.0; extra == "doc"
Requires-Dist: autoapi>=2.0.1; extra == "doc"
Requires-Dist: sphinx_autodoc_typehints~=3.17; extra == "doc"
Requires-Dist: sphinxcontrib-mermaid~=2.1; extra == "doc"
Requires-Dist: pyTooling.Sphinx[reports]~=1.0; extra == "doc"
Requires-Dist: pyTooling.Sphinx~=1.0; extra == "doc"
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
Requires-Dist: pyTooling<11.0,>=10.1.1; extra == "doc"
Requires-Dist: sphinx_rtd_theme~=3.1; extra == "doc"
Provides-Extra: test
Requires-Dist: sphinx>=9.1.1; extra == "test"
Requires-Dist: docutils_stubs~=0.0.22; extra == "test"
Requires-Dist: Coverage~=7.17; extra == "test"
Requires-Dist: pytest-xdist~=3.8; extra == "test"
Requires-Dist: pyVHDLModel~=0.40.0; extra == "test"
Requires-Dist: mypy[reports]~=2.4; extra == "test"
Requires-Dist: pytest~=9.1; extra == "test"
Requires-Dist: pyTooling.Sphinx~=1.0; extra == "test"
Requires-Dist: pyTooling<11.0,>=10.1.1; extra == "test"
Requires-Dist: pytest-cov~=7.1; extra == "test"
Provides-Extra: all
Requires-Dist: sphinx>=9.1.1; extra == "all"
Requires-Dist: sphinx_design~=0.7.0; extra == "all"
Requires-Dist: docutils_stubs~=0.0.22; extra == "all"
Requires-Dist: Coverage~=7.17; extra == "all"
Requires-Dist: pytest-xdist~=3.8; extra == "all"
Requires-Dist: sphinx_autodoc_typehints~=3.17; extra == "all"
Requires-Dist: pyVHDLModel~=0.40.0; extra == "all"
Requires-Dist: autoapi>=2.0.1; extra == "all"
Requires-Dist: mypy[reports]~=2.4; extra == "all"
Requires-Dist: sphinxcontrib-mermaid~=2.1; extra == "all"
Requires-Dist: pytest~=9.1; extra == "all"
Requires-Dist: pyTooling.Sphinx[reports]~=1.0; extra == "all"
Requires-Dist: pyTooling.Sphinx~=1.0; extra == "all"
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
Requires-Dist: pyTooling<11.0,>=10.1.1; extra == "all"
Requires-Dist: pytest-cov~=7.1; extra == "all"
Requires-Dist: sphinx_rtd_theme~=3.1; extra == "all"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

[![Sourcecode on GitHub](https://img.shields.io/badge/VHDL-VHDLDomain-29b6f6.svg?longCache=true&style=flat-square&logo=GitHub&labelColor=0277bd)](https://GitHub.com/VHDL/VHDLDomain)
[![Sourcecode License](https://img.shields.io/pypi/l/VHDLDomain?longCache=true&style=flat-square&logo=Apache&label=code)](LICENSE.md)
[![Documentation](https://img.shields.io/website?longCache=true&style=flat-square&label=VHDL.github.io%2FVHDLDomain&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2FVHDL.github.io%2FVHDLDomain%2Findex.html)](https://VHDL.github.io/VHDLDomain/)
[![Documentation License](https://img.shields.io/badge/doc-CC--BY%204.0-green?longCache=true&style=flat-square&logo=CreativeCommons&logoColor=fff)](doc/Doc-License.rst)
[![Gitter](https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef)](https://gitter.im/hdl/community)  
[![PyPI](https://img.shields.io/pypi/v/VHDLDomain?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)](https://pypi.org/project/VHDLDomain/)
![PyPI - Status](https://img.shields.io/pypi/status/VHDLDomain?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/VHDLDomain?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)  
[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/actions/workflow/status/VHDL/VHDLDomain/Pipeline.yml?branch=main&longCache=true&style=flat-square&label=build%20and%20test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://GitHub.com/VHDL/VHDLDomain/actions/workflows/Pipeline.yml)
[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/VHDLDomain?longCache=true&style=flat-square&logo=Libraries.io&logoColor=fff)](https://libraries.io/github/VHDL/VHDLDomain)
[![Codacy - Quality](https://img.shields.io/codacy/grade/2286426d2b11417e90010427b7fed8e7?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/VHDL/VHDLDomain/dashboard)
[![Codacy - Coverage](https://img.shields.io/codacy/coverage/2286426d2b11417e90010427b7fed8e7?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/VHDL/VHDLDomain/dashboard)
[![Codecov - Branch Coverage](https://img.shields.io/codecov/c/github/VHDL/VHDLDomain?longCache=true&style=flat-square&logo=Codecov)](https://codecov.io/gh/VHDL/VHDLDomain)

# 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

* [Patrick Lehmann](https://GitHub.com/Paebbels) (Maintainer)
* [and more...](https://GitHub.com/VHDL/VHDLDomain/graphs/contributors)


## License

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


-------------------------

SPDX-License-Identifier: Apache-2.0
