Skip to content

Commit b54c153

Browse files
authored
Cleanup commits (#186)
* Remove deprecated PackRF device Signed-off-by: Travis F. Collins <[email protected]> * Cleanup and fix MATLAB side of doc generation Signed-off-by: Travis F. Collins <[email protected]> * Update GHA to generate doc json before HTML gen Signed-off-by: Travis F. Collins <[email protected]> * Update doc checkout to be recursive Signed-off-by: Travis F. Collins <[email protected]> * Add dependent toolboxes and HSPs for CI builds Signed-off-by: Travis F. Collins <[email protected]> --------- Signed-off-by: Travis F. Collins <[email protected]>
1 parent 4b1b3c6 commit b54c153

File tree

5 files changed

+770
-629
lines changed

5 files changed

+770
-629
lines changed

+adi/+PackRF/Rx.m

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

+adi/+PackRF/Tx.m

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

.github/workflows/doc.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,33 @@ jobs:
88

99
steps:
1010
- uses: actions/checkout@v2
11+
with:
12+
submodules: recursive
1113
- name: Set up Python 3.7
1214
uses: actions/setup-python@v2
1315
with:
1416
python-version: 3.7
1517

18+
- name: Set up MATLAB
19+
uses: matlab-actions/setup-matlab@v2
20+
with:
21+
release: R2023b
22+
products: >
23+
Signal_Processing_Toolbox
24+
DSP_System_Toolbox
25+
Communications_Toolbox
26+
Communications_Toolbox_Support_Package_for_Analog_Devices_ADALM-Pluto_Radio
27+
1628
- name: Install dependencies
1729
run: |
1830
sudo apt install -y python3-numpy
1931
pip install -r CI/doc/requirements_doc.txt
32+
33+
- name: Generate MATLAB side of doc
34+
uses: matlab-actions/run-command@v1
35+
with:
36+
command: addpath(genpath('.')); gen_sysobj_doc; exit();
37+
2038
- name: Check doc build
2139
run: |
2240
make -C CI/doc gen_autodocs html

CI/doc/gen_pages/gen_sysobj_doc.m

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,20 @@
66
mfiledir = fullfile('adi');
77
docdir = fullfile('doc');
88
parts = {'AD9361'; 'AD9363'; 'AD9364'; ...
9-
'AD9371'; 'ADRV9009'; 'ADRV9361Z7035'; ...
10-
'ADRV9364Z7020'; 'ADRV9371'; 'FMComms2'; ...
11-
'FMComms3'; 'FMComms4'; 'PackRF'; 'Pluto';...
12-
'ADRV9002'; 'FMComms8'; 'ADRV9009ZU11EG'};
9+
'AD9371'; 'ADRV9371'; ...
10+
'ADRV9009'; ...
11+
'ADRV9361Z7035'; 'ADRV9364Z7020'; ...
12+
'FMComms2'; 'FMComms3'; 'FMComms4'; 'FMComms5'; ...
13+
'Pluto';...
14+
'ADRV9002'; ...
15+
'ADRV9009ZU11EG'; 'FMComms8'};
1316
trx_files = {'Tx','Rx'};
1417

1518
all_devs = [];
1619
for ii = 1:numel(parts)
1720
for jj = 1:numel(trx_files)
1821
all_props = [];
22+
fprintf('%s %s\n', parts{ii}, trx_files{jj});
1923
dotmfilename = strcat(mfiledir, '.', parts{ii}, '.', trx_files{jj});
2024
props = properties(dotmfilename);
2125
for prop = 1:length(props)
@@ -34,6 +38,16 @@
3438
prop_description = char(prop_description);
3539
prop_description = replace(prop_description,' ',' ');
3640
prop_description = replace(prop_description,' ',' ');
41+
42+
% Remove inherited text notes
43+
if contains(prop_description, 'inherited from superclass')
44+
loc = strfind(prop_description, 'Help for ');
45+
if ~isempty(loc)
46+
prop_description = prop_description(1:loc-1);
47+
else
48+
warning('inherited text not as expected');
49+
end
50+
end
3751

3852
s = struct('prop_name',props{prop},...
3953
'prop_title',prop_title,...
@@ -60,7 +74,7 @@
6074
end
6175
%%
6276
jsonText = jsonencode(all_devs,'PrettyPrint',true);
63-
fid = fopen(fullfile('CI','gen_doc','docs','sysobjs.json'), 'w');
77+
fid = fopen(fullfile('CI','doc','gen_pages','sysobjs.json'), 'w');
6478
fprintf(fid, '%s', jsonText);
6579
fclose(fid);
6680

0 commit comments

Comments
 (0)