Skip to content

Commit b2747b5

Browse files
authored
Merge pull request #131 from analogdevicesinc/doc-mlhelp
Fix doc in MATLAB help
2 parents 13892f3 + 421e41f commit b2747b5

File tree

4 files changed

+6
-2
lines changed

4 files changed

+6
-2
lines changed

CI/gen_doc/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,14 @@ GITTAG := $(shell git describe --tags HEAD)
4242
.ONESHELL:
4343

4444
doc_ml:
45-
cd ../.. ; \
4645
cd docs ; \
4746
cp ../../scripts/ports.json . ; \
4847
cp ../../scripts/read_ports_json.py . ; \
4948
python3 read_ports_json.py ; \
5049
MATLAB=ON python3 gen_all_doc.py ; \
5150
cd .. ; \
5251
mkdocs build -d doc
52+
mv doc ../../
5353

5454
doc:
5555
cd docs ; \

CI/gen_doc/docs/_pages/targeting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
{% include 'header.tmpl' %}
22
# HDL Targeting with HDL-Coder
33

44
High-Speed Converter Toolbox supports the IP Core generation flow from MathWorks which allows for automated integration of DSP into HDL reference designs from Analog Devices. This workflow will take Simulink subsystems, run HDL-Coder to generate source Verilog, and then integrate that into a larger reference design. The figure below is a simplified block diagram of a SoC (Fabric+ARM) device, where specialized IP are inserted into the receive and transmit datapaths. This is supported on specific FPGA families and high-speed based reference designs. This support is based on the Zynq HDL-Coder and support

CI/gen_doc/docs/gen_md_pages.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ def gen_toc(pages, devices, designs):
3333

3434
template = env.get_template("toc.tmpl")
3535

36+
pages.remove('index')
37+
pages.remove('ad9081')
3638
output = template.render(pages=pages, devices=devices, designs=designs)
3739

3840
loc = os.path.dirname(__file__)

Jenkinsfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ stage("Build Toolbox") {
1515
withEnv(['HDLBRANCH='+branchName]) {
1616
checkout scm
1717
sh 'git submodule update --init'
18+
sh 'pip3 install -r ./CI/gen_doc/requirements_doc.txt'
19+
sh 'make -C ./CI/gen_doc doc_ml'
1820
sh 'make -C ./CI/scripts build'
1921
sh 'make -C ./CI/scripts gen_tlbx'
2022
}

0 commit comments

Comments
 (0)