Skip to content

Commit

Permalink
Merge pull request #131 from analogdevicesinc/doc-mlhelp
Browse files Browse the repository at this point in the history
Fix doc in MATLAB help
  • Loading branch information
tfcollins authored Mar 23, 2023
2 parents 13892f3 + 421e41f commit b2747b5
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CI/gen_doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ GITTAG := $(shell git describe --tags HEAD)
.ONESHELL:

doc_ml:
cd ../.. ; \
cd docs ; \
cp ../../scripts/ports.json . ; \
cp ../../scripts/read_ports_json.py . ; \
python3 read_ports_json.py ; \
MATLAB=ON python3 gen_all_doc.py ; \
cd .. ; \
mkdocs build -d doc
mv doc ../../

doc:
cd docs ; \
Expand Down
2 changes: 1 addition & 1 deletion CI/gen_doc/docs/_pages/targeting.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

{% include 'header.tmpl' %}
# HDL Targeting with HDL-Coder

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
Expand Down
2 changes: 2 additions & 0 deletions CI/gen_doc/docs/gen_md_pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ def gen_toc(pages, devices, designs):

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

pages.remove('index')
pages.remove('ad9081')
output = template.render(pages=pages, devices=devices, designs=designs)

loc = os.path.dirname(__file__)
Expand Down
2 changes: 2 additions & 0 deletions Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ stage("Build Toolbox") {
withEnv(['HDLBRANCH='+branchName]) {
checkout scm
sh 'git submodule update --init'
sh 'pip3 install -r ./CI/gen_doc/requirements_doc.txt'
sh 'make -C ./CI/gen_doc doc_ml'
sh 'make -C ./CI/scripts build'
sh 'make -C ./CI/scripts gen_tlbx'
}
Expand Down

0 comments on commit b2747b5

Please sign in to comment.