用于生成 Matlab HTML 文档的 Sphinx 扩展。
项目描述
sphinx-matlabdoc-builder
用于生成 Matlab HTML 文档的 Sphinx 扩展。此扩展将 Sphinx 项目构建为一组 HTML 文档，并另外生成Matlab 工具箱文档helptoc.xml所需的 TOC 文件
要为 Matlab 代码生成文档，请查看 matlabdomain Sphinx 扩展。
安装
该软件包可以从Pip安装
pip install sphinx-matlabdoc-builder
或者，您可以将sphinx_matlabdoc_builder包下载到 sphinx 目录中，并将本地目录添加到 sphinx 路径中。
要求
这个包是 Sphinx 的扩展。需要 Python 3。
用法
要使用 sphinx-matlabdoc-builder，您必须首先安装该软件包并将扩展名添加到您的 sphinxconf.py文件中。例如，将
sphinx_matlabdoc_builder扩展名添加到扩展名列表的末尾：
extensions = [
'sphinx.ext.mathjax',
'sphinx.ext.githubpages',
'sphinx_matlabdoc_builder',
]
然后编译源代码
make matlabdoc
或者如果使用sphinx-build
sphinx-build -M matlabdoc ./ build
这应该会生成正常的 HTML 输出并将helptoc.xml
文件添加到输出目录。
要使用helptoc.xml工具箱中的文件，请创建一个新的 matlab 包并单击添加文档并指定文档输出目录。如果您有一个现有info.xml文件，只需将文档目录更改为指向包含该helptoc.xml文件的输出目录。例如，在 Matlab 2018a 上，info.xml文件可能类似于：
<?xml version="1.0" encoding="utf-8"?>
<productinfo xmlns: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>
wherehelp_location指定 Sphinx 输出目录的路径。
关
sphinx_matlabdoc_builder -0.1.2-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 21f56d30835925a319f7a65608c3974443458589d5721a3ad1a4f84665c5532a |
|
| MD5 | aef41a7edb6fa52f93b91150f87fc04e |
|
| 布莱克2-256 | 28463068079ea46e562f859c8ec71f2ad2c7c7d14f798975903f5bd97b797a78 |