A Sphinx autodoc extension for SystemVerilog, powered by
the pyslang parser.
It documents SystemVerilog source the way sphinx.ext.autodoc documents Python: declarations
and their doc comments are pulled directly from source, supporting multiple comment dialects
(a Python-docstring-like native style, NaturalDocs, and Doxygen).
📖 Documentation: https://fvutils.github.io/sphinx-systemverilog/
Status: early development. See
docs/design/for the design and implementation plan.
Installation
pip install sphinx-systemverilog
Quick start
# docs/conf.py
extensions = ["sphinx_systemverilog"]
sv_source_dirs = ["../rtl"]
sv_doc_style = "native"
.. autosvclass:: my_pkg::my_transaction
:members:
Development
source packages/python/bin/activate
pip install -e .
pytest -m "unit or sphinx"
sphinx-build -W docs docs/_build/html
License
Apache-2.0.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_systemverilog-0.1.0.tar.gz.
File metadata
- Download URL: sphinx_systemverilog-0.1.0.tar.gz
- Upload date:
- Size: 41.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
501e805dd637759cc0d3e19b89304b9502caf292859aeb13a3eec09b74cb2b16
|
|
| MD5 |
30664ac97c4c39bdbc4fd082c14e835d
|
|
| BLAKE2b-256 |
18bad2b097e57aa16e1c3f771f4c0ddc656788dfd66abeed7b84d45c0a268dc4
|
File details
Details for the file sphinx_systemverilog-0.1.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_systemverilog-0.1.0-py3-none-any.whl
- Upload date:
- Size: 48.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
807267a7996c58bba50572705a4328ae96879c68b82f0929d3e7edd35341c31e
|
|
| MD5 |
5c69f5df669e6d590df19ecacaac08f9
|
|
| BLAKE2b-256 |
e42d43dfd43a1dcea55a423e18a91ed574ee9f8324efd556afd7e0da2ee56697
|
