[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Updating in-tree block documentation
From: |
Karl |
Subject: |
Updating in-tree block documentation |
Date: |
Thu, 20 May 2021 13:53:28 -0400 |
Hi,
I am just learning gnuradio and I find it takes a lot of time to look
up the blocks on the wiki.
The attached python script, if run in the gnuradio source tree root,
will update all the blocks' local documentation from the wiki.
It uses requests, pyyaml, and mwparserfromhell.
It makes a _lot_ of updates. A patch updating them all would be pretty large.
Here is an example:
--- a/gr-blocks/grc/blocks_add_const_vxx.block.yml
+++ b/gr-blocks/grc/blocks_add_const_vxx.block.yml
@@ -49,4 +49,14 @@ cpp_templates:
callbacks:
- set_k(${const})
+documentation: |-
+ Category:Block Docs
+ Adds a constant value to each item that passes though. output[m]
= input[m] + constant vector.
+
+ Parameters
+ (R): Run-time adjustable
+
+ Constant (R)
+ The entered value must be of the same type as the input / output
ports (i.e. complex, float, etc.).
+
update_docs_from_wiki.py
Description: Text Data
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- Updating in-tree block documentation,
Karl <=