The SkyWater PDK defines a bunch of "rst roles" in it's sphinx conf.py file. These include things like;
lib
cell
model
Which are used like this in the SkyWater PDK documentation;
:lib:`sky130_fd_io` - SKY130 IO and periphery cells (SkyWater Provided)
and like follows;
Libraries in the SKY130 PDK are named using the following scheme;
:lib_process:`<Process name>` _ :lib_src:`<Library Source Abbreviation>` _ :lib_type:`<Library Type Abbreviation>` [_ :lib_name:`<Library Name>`]
Which results in the following colorization in the PDK documentation;
In the future, it would also be good if it resulted in these nodes also being clickable links to useful things.
This is useful for documenting all the PDKs which follow our naming process. We should move it into this repository and make it shared.
The SkyWater PDK defines a bunch of "rst roles" in it's sphinx
conf.py
file. These include things like;Which are used like this in the SkyWater PDK documentation;
and like follows;
Which results in the following colorization in the PDK documentation;
In the future, it would also be good if it resulted in these nodes also being clickable links to useful things.
This is useful for documenting all the PDKs which follow our naming process. We should move it into this repository and make it shared.
This is done with the following Python code;