Skip to content

Commit 6fd9ff7

Browse files
committed
Rework documentation
Make documentation interleaved with the code. Use rst files within various libraries.
1 parent 526d16e commit 6fd9ff7

File tree

29 files changed

+259
-144
lines changed

29 files changed

+259
-144
lines changed

doc/img/axis_buffer2.drawio.svg

Lines changed: 0 additions & 4 deletions
This file was deleted.

doc/img/axis_buffer2.svg

Lines changed: 0 additions & 4 deletions
This file was deleted.

doc/img/axis_packer.drawio.svg

Lines changed: 0 additions & 4 deletions
This file was deleted.

doc/img/axis_packer.svg

Lines changed: 0 additions & 4 deletions
This file was deleted.

lib/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,6 @@ backend-agnostic implementations.
2020
nsl_clocking/index
2121
nsl_io/index
2222
nsl_color/index
23+
nsl_event/index
2324
debug
25+
network

lib/interconnect.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ Custom On-chip Communication Framework
3434
--------------------------------------
3535

3636
Before implementing high-end standard interconnects, NSL had the need
37-
for an efficient communication framework. `bnoc`_ is a set of 8-bit
37+
for an efficient communication framework. `bnoc <bnoc/index>`_ is a set of 8-bit
3838
wide data streaming infrastructure models, with various features
3939
depending on the needs.

lib/network.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
===============
2+
Network stack
3+
===============
4+
5+
.. toctree::
6+
7+
nsl_smi/index
8+
nsl_mii/index
9+
nsl_inet/index

lib/nsl_amba/apb/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ older).
1313
Configuration for APB is held in ``config_t`` record type. It holds the
1414
follwing settings:
1515

16-
* Address, data, *user,
16+
* Address, data, \*user,
1717
* prot, rme, strb, ready, err and wakeup fields availability.
1818

1919
``config()`` function can generate such a configuration yet ensuring it

lib/nsl_amba/axi4_mm/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,6 @@ interfaces.
251251
synchronous interface to backend access in terms of read and write
252252
channel, non concurrent.
253253

254-
.. vhdl:symbol:: nsl_amba.axi4_mm.axi4_mm_lite_slave
255-
256254
* :vhdl:component:`nsl_amba.axi4_mm.axi4_mm_lite_regmap` is
257255
abstracting even more as it:
258256

lib/nsl_amba/axi4_stream/axi4_stream.pkg.vhd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,7 @@ package axi4_stream is
265265
out_o : out master_t;
266266
out_i : in slave_t
267267
);
268+
--@-- grouped name:in_, members:in_i;in_o
268269
end component;
269270

270271
-- This extracts a header of fixed size from the stream. Header is

0 commit comments

Comments
 (0)