Skip to content

Commit

Permalink
doc: regenerate block docs
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Klotzbuecher <mk@mkio.de>
  • Loading branch information
kmarkus committed Jun 23, 2020
1 parent 8aef399 commit c0aea98
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 7 deletions.
13 changes: 7 additions & 6 deletions docs/user/block_index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
Microblx Module Index
=====================

.. include:: block_trig.rst
.. include:: block_ptrig.rst
.. include:: block_math_double.rst
.. include:: block_rand_double.rst
.. include:: block_ramp_double.rst
.. include:: block_pid.rst
.. include:: block_saturation_double.rst
.. include:: block_luablock.rst
.. include:: block_ramp_double.rst
.. include:: block_rand_double.rst
.. include:: block_math_double.rst
.. include:: block_cconst.rst
.. include:: block_iconst.rst
.. include:: block_ptrig.rst
.. include:: block_trig.rst
.. include:: block_lfds_cyclic.rst
.. include:: block_hexdump.rst
.. include:: block_mqueue.rst
.. include:: block_hexdump.rst
35 changes: 35 additions & 0 deletions docs/user/block_saturation_double.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Module saturation_double
------------------------

Block saturation_double
^^^^^^^^^^^^^^^^^^^^^^^

| **Type**: cblock
| **Attributes**:
| **Meta-data**: double saturation block
| **License**: BSD-3-Clause

Configs
"""""""

.. csv-table::
:header: "name", "type", "doc"

data_len, ``long``, "data array length"
lower_limits, ``double``, "saturation lower limits"
upper_limits, ``double``, "saturation upper limits"



Ports
"""""

.. csv-table::
:header: "name", "out type", "out len", "in type", "in len", "doc"

in, , , ``double``, 1, "sat generator output"
out, ``double``, 1, , , "sat generator output"



13 changes: 12 additions & 1 deletion gen_block_userdoc.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
#!/usr/bin/bash

BLOCKS="pid luablock ramp_double rand_double math_double cconst iconst ptrig trig lfds_cyclic hexdump mqueue"
BLOCK_INDEX=docs/user/block_index.rst

BLOCKS="trig ptrig \
math_double \
rand_double \
ramp_double \
pid \
saturation_double \
luablock \
cconst \
iconst \
lfds_cyclic mqueue hexdump \
"

cat <<EOF > $BLOCK_INDEX
Microblx Module Index
=====================
Expand Down

0 comments on commit c0aea98

Please sign in to comment.