Skip to content

Commit 29b0d48

Browse files
committed
Add community plugins page
1 parent 8b22af7 commit 29b0d48

File tree

4 files changed

+110
-3
lines changed

4 files changed

+110
-3
lines changed

docs/community.rst

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
.. _community-plugins:
2+
3+
Community Plugins
4+
=================
5+
6+
Below is a list of other PeakRDL plugins created by community members.
7+
8+
If you've made your own plugin, feel free to [open a PR to add yours](https://github.com/SystemRDL/PeakRDL/edit/main/docs/community.rst) to this list.
9+
10+
11+
12+
Test/Software Abstraction Layers
13+
--------------------------------
14+
15+
.. list-table::
16+
:header-rows: 1
17+
18+
* - Plugin
19+
- Author
20+
- Summary
21+
22+
* - `PeakRDL-beam <https://peakrdl-beam.readthedocs.io/en/latest/>`_
23+
- `João Henrique Ferreira de Freitas <https://github.com/joaohf>`_
24+
- Generate a register abstraction layer for supported BEAM languages
25+
(Erlang and Elixir) a SystemRDL definition.
26+
27+
* - `peakRDL-cocotb-ralgen <https://dyumnin.github.io/cocotb-ralgen>`_
28+
- `Dyumnin Semiconductor <https://github.com/dyumnin>`_
29+
- A SystemRDL to raltest converter for cocotb
30+
31+
* - `PeakRDL-euvm <https://github.com/coverify/PeakRDL-euvm>`_
32+
- `Coverify <https://github.com/coverify>`_
33+
- Generate an eUVM register model
34+
35+
* - `PeakRDL-halcpp <https://risto97.github.io/PeakRDL-halcpp/docs/intro>`_
36+
- `Risto Pejašinović <https://github.com/Risto97>`_
37+
- Generate a C++ Hardware Abstraction Layer
38+
39+
* - `PeakRDL-pss <https://github.com/mballance/PeakRDL-pss>`_
40+
- `Matthew Ballance <https://github.com/mballance>`_
41+
- Generate PSS (Portable test and Stimulus Standard)
42+
43+
* - `PeakRDL-python <https://peakrdl-python.readthedocs.io>`_
44+
- `Keith Brady <https://github.com/krcb197>`_
45+
- Generate a Python Hardware Abstraction Layer
46+
47+
* - `PeakRDL-python-simple <https://peakrdl-python-simple.readthedocs.io>`_
48+
- `Marek Pikuła <https://github.com/MarekPikula>`_
49+
- Simplified Python register abstraction layer exporter
50+
51+
52+
53+
RTL Generators
54+
--------------
55+
56+
.. list-table::
57+
:header-rows: 1
58+
59+
* - Plugin
60+
- Author
61+
- Summary
62+
63+
* - `PeakRDL-bsv <https://github.com/jahagirdar/peakrdl-bsv>`_
64+
- `Vijayvithal <https://github.com/jahagirdar>`_
65+
- Generate Bluespec SystemVerilog RTL
66+
67+
* - `PeakRDL-sv <https://github.com/NuQuantum/peakrdl-sv>`_
68+
- `Nu Quantum <https://github.com/NuQuantum>`_
69+
- Simplified SystemVerilog generator
70+
71+
72+
73+
Documentation
74+
-------------
75+
76+
.. list-table::
77+
:header-rows: 1
78+
79+
* - Plugin
80+
- Author
81+
- Summary
82+
83+
* - `PeakRDL-docx <https://pypi.org/project/peakrdl-docx>`_
84+
- `Alex Nijmeijer <https://github.com/nijmeijer>`_
85+
- Compile SystemRDL definitions into a Docx (MsWord) document
86+
87+
* - `PeakRDL-Markdown <https://peakrdl-markdown.readthedocs.io>`_
88+
- `Marek Pikuła <https://github.com/MarekPikula>`_
89+
- Generate Markdown documentation
90+
91+
92+
93+
Format Converters
94+
-----------------
95+
96+
.. list-table::
97+
:header-rows: 1
98+
99+
* - Plugin
100+
- Author
101+
- Summary
102+
103+
* - `PeakRDL-opentitan <https://risto97.github.io/PeakRDL-opentitan/>`_
104+
- `Risto Pejašinović <https://github.com/Risto97>`_
105+
- Convert to and from OpenTitan hjson format

docs/gallery.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,4 @@ Run your own custom command
101101
PeakRDL can be extended with additional user-defined commands.
102102
See more details here: :ref:`exporter-plugin`
103103

104-
Or, check out the various `community-contributed plugins <https://github.com/SystemRDL/.github/blob/main/community_plugins.md>`_ already available.
104+
Or, check out the various :ref:`community-plugins` already available.

docs/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ This tool can:
1616
* Import & export IP-XACT XML.
1717
* Create rich and dynamic HTML documentation.
1818
* Build a UVM register model abstraction layer.
19-
* ... or extended this tool with your own plugins
19+
* Be extended by :ref:`exporter-plugin` plugin.
20+
* ... or use one of the many :ref:`community-plugins`
2021

2122

2223

@@ -52,6 +53,7 @@ Links
5253
processing-input
5354
configuring
5455
licensing
56+
community
5557

5658
.. toctree::
5759
:hidden:

src/peakrdl/importer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ def add_importer_arguments(self, arg_group: 'argparse._ActionsContainer') -> Non
7070
Not all exporter configuration options are appropriate as command-line arguments.
7171
For options that will likely remain static for a given user/organization,
7272
consider using the PeakRDL TOML configuration mechanism via the
73-
``cft_schema`` and ``cfg`` class members.
73+
``cfg_schema`` and ``cfg`` class members.
7474
7575
Parameters
7676
----------

0 commit comments

Comments
 (0)