Complete new asset documentation system mainstreaming into OpenCPI
Problem identified
A number of cleanup tasks need to be performed after the new asset documentation system is merged (!381 (merged)) and the converted OpenCPI asset documentation is merged (!551 (merged)) so that the new asset documentation system is fully mainstreamed into OpenCPI and can be used to develop new asset documentation.
Cleanup tasks
-
Merge new and modified doc tool files into the mainstreamed asset doc system.
-
Build the merged converted documentation with the merged asset documentation system to make sure everything works properly.
-
Remove the LaTeX versions of converted data sheets (unless the new doc tools cannot currently automatically generate all of the information that is in the data sheet from the asset XML files).
Location of obsolete LaTeX data sheet documents
projects/core/components/backpressure.test/doc/backpressure.tex
projects/core/components/file_read.test/doc/file_read.tex
projects/core/components/file_read.test/doc/snippets/messaging_snippet.tex
projects/core/components/file_write.test/doc/file_write.tex
projects/core/components/file_write.test/doc/snippets/messaging_snippet.tex
projects/core/components/metadata_stressor.test/doc/metadata_stressor.tex
projects/platform/hdl/devices/data_sink_qdac.test/doc/data_sink_qdac.tex
projects/platform/hdl/devices/data_src_qadc.test/doc/data_src_qadc.tex
projects/platform/hdl/platforms/zed/doc/ZedBoard_Getting_Started_Guide.tex
projects/assets/hdl/devices/ad9361_config_proxy.test/doc/AD9361_Config_Proxy.tex
projects/assets/hdl/devices/ad9361_config.test/doc/AD9361_Config.tex
projects/assets/hdl/devices/ad9361_data_sub.test/doc/AD9361_Data_Sub.tex
projects/assets/hdl/devices/ad9361_spi.test/doc/AD9361_SPI.tex
Location of doc tool files
tools/python/_opencpi/ocpidoc/ocpi_documentation/conf.py
tools/python/_opencpi/ocpidoc/ocpi_documentation/static/css/ocpidocument-style.css
tools/python/_opencpi/ocpidoc/ocpi_documentation/static/logo_ocpi.svg
Links/references
This issue is a follow-on task of !551 (merged) and #1713 (closed) and !381 (merged).