hdmf-docutils 0.4.1

概述

这个项目是cli、脚本和模块的集合，这些都有助于生成HDMF文档。在

使用hdmf docutils为扩展生成文档：http://pynwb.readthedocs.io/en/latest/extensions.html#documenting-extensions

安装

pip install hdmf-docutils

可用工具

• hdmf_generate_format_docs：根据hdmfyaml规范为 格式规范文件。以前称为“nwb生成格式文档”。在
• hdmf_init_sphinx_extension_doc：为HDMF扩展创建格式规范SPHINX文档。 以前称为“nwb_init_sphinx_extension_doc”。在
• hdmf_gallery_prototype：用于制作sphinx画廊示例原型的工具。以前称为“西北美术馆原型”。在

可用模块

• hdmf_docutils/doctools/*：此包包含用于生成 HDMF文件和规范，以及帮助以编程方式生成RestructedText（RST） 文件。在

可用笔记本

• compare-hdf5-files.ipynb：这个 笔记本电脑演示了如何比较hdf5文件。在

历史

2020年1月，nwb docutils更名为hdmf docutils，并概括为（大部分）独立于nwb。在

nwb docutils最初是nwb模式项目的子目录。在 将4th NWB Hackathon转换为 专用的pip installable项目，以便于核心NWB文档项目和各种 NWB扩展。在