Documentation Upgrade Working Group: Difference between revisions
Jump to navigation
Jump to search
(initial creation) |
|||
| Line 12: | Line 12: | ||
=== Create new process / work flow to generate user-friendly block docs === | === Create new process / work flow to generate user-friendly block docs === | ||
Current Wiki Block docs have the following sections: | |||
* A functional description | |||
* Parameters | |||
* An example flowgraph | |||
* Links to the source code | |||
** C++ or Python | |||
** Include files | |||
** YML file | |||
== Road map for group == | == Road map for group == | ||
What are the plans to move forward? | What are the plans to move forward? | ||
Revision as of 14:42, 18 September 2023
The purpose of this group is to address issues related to documenting blocks in a manner which uses source code of the blocks as the basis of all related documents.
Items to address
How will block docs be different between 3.x and 4.0?
Use of Doxygen / Sphinx / Wiki
Examine current process of generating the doxygen manual
The GNU Radio Manual and C++ API Reference document currently does not reflect the current release version.
Create new process / work flow to generate user-friendly block docs
Current Wiki Block docs have the following sections:
- A functional description
- Parameters
- An example flowgraph
- Links to the source code
- C++ or Python
- Include files
- YML file
Road map for group
What are the plans to move forward?