生成MatlabHTML文档的Sphinx扩展。
sphinx-matlabdoc-builder的Python项目详细描述
斯芬克斯matlabdoc生成器
生成MatlabHTML文档的Sphinx扩展。
这个扩展将Sphinx项目构建成一组HTML
并额外生成TOChelptoc.xml文件
需要
Matlab toolbox documentation
要生成Matlab代码的文档，请查看 matlabdomain狮身人面像扩展。在
安装
该软件包可以从Pip安装
pip install sphinx-matlabdoc-builder
或者，您可以将sphinx_matlabdoc_builder包下载到
并将本地目录添加到sphinx路径中。在
要求
这个包是斯芬克斯的扩展。 需要Python 3。在
使用
要使用sphinx matlabdoc builder，必须首先安装包并添加
sphinxconf.py文件的扩展名。例如，添加
sphinx_matlabdoc_builder扩展到扩展列表末尾：
然后用
make matlabdoc
或者如果使用sphinx-build
sphinx-build -M matlabdoc ./ build
这将生成正常的HTML输出并添加helptoc.xml
文件到输出目录。在
要使用工具箱中的helptoc.xml文件，请创建一个新的matlab
打包并单击添加文档并指定文档
输出目录。
如果您有一个现有的info.xml文件，只需更改文档即可
指向包含helptoc.xml文件的输出目录。
例如，在Matlab2018a中，info.xml文件可能类似于：
<?xml version="1.0" encoding="utf-8"?><productinfoxmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="optional"><?xml-stylesheet type="text/xsl"href="optional"?><matlabrelease>2018a</matlabrelease><name>otslm</name><type>toolbox</type><icon/><help_location>docs\_build\matlabdoc</help_location><help_contents_icon/></productinfo>
其中help_location指定Sphinx输出目录的路径。在
- 项目
标签：
欢迎加入QQ群-->： 979659372
