This sphinx extension adds a new language domain to Sphinx. It allows the documentation of VHDL source files.
License: Apache 2.0
.. vhdl:library:: myLibrary
Description text.. vhdl:context:: myContext
Description text.. vhdl:entity:: myEntity
Description text.. vhdl:architecture:: rtl
:entity: myEntity
Description text.. vhdl:package:: myPackage
Description text.. vhdl:packagebody:: myPackage
Description text.. vhdl:package:: myConfiguration
Description text.. vhdl:use:: IEEE.std_logic_1164.all
Description text.. vhdl:ctx:: work.myContext
Description text.. vhdl:enum:: myState
:literals: IDLE, WORKING, ERROR
Description text.. vhdl:integer:: myInteger
:range: 0 to 255
Description text.. vhdl:physical:: myFrequency
:primary: Hz
:secondary: kHz=1000 Hz, MHz=1000kHz, GHz=1000MHz
Description text.. vhdl:float:: myReal
:range: 0.0 to 1.0
Description text.. vhdl:array:: myArray
:elementType: bit
:indexTypes: natural range <>, natural range <>
Description text.. vhdl:record:: myRecord
:elements: element1:string, element2:integer
Description text.. vhdl:protected:: myProtected
Description text.. vhdl:constant:: myConstant
:type:
:init:
Description text.. vhdl:signal:: mySignal
:type:
:init:
Description text.. vhdl:sharedvar:: mySharedVariable
:type:
Description text.. vhdl:function:: function myfunction(a : integer) return string;
:method:
:pure:
:impure:
Description text.. vhdl:procedure:: myprocedure(a : integer)
:method:
Description text.. vhdl:parameter:: a : integer
Description text.. vhdl:returntype:: string
Description text