nwb-docutils 0.3.1

概述

该项目是一组用于生成NWB文档的有用的CLIs、脚本和模块。

使用nwb-docutils生成扩展文档：[http://pynwb.readthedocs.io/en/latest/extensions.html#documenting-extensions](http://pynwb.readthedocs.io/en/latest/extensions.html#documenting-extensions)

安装

pip install nwb-docutils

可用工具

• nwb_generate_format_docs：从NWB YAML规范生成格式规范文档的图像和RST文档。

• nwb_init_sphinx_extension_doc：为NWB扩展创建格式规范SPHINX文档。

• nwb_gallery_prototype

可用模块

• nwb_docutils/doctools/*：此软件包包含用于生成NWB-N文件和规范层次结构的图像以及帮助程序生成reStructuredText（RST）文档的模块。

可用Notebooks

• [compare-hdf5-files.ipynb](https://github.com/NeurodataWithoutBorders/nwb-docutils/blob/master/nwb_docutils/compare-hdf5-files.ipynb)：此Notebook展示了如何比较hdf5文件。

历史

nwb-utils最初是nwb-schema项目的子目录。在第4届NWB黑客马拉松期间，相应的历史被提取到一个专门的项目中，以便核心NWB文档项目和各种NWB扩展都能使用。

维护者：如何发布？

1. 如此处所述，配置~/.pypirc。

2. 确保CLI和模块按预期工作。

3. 按版本排序列出所有标签

   $ git fetch --tags && \
     git tag -l | sort -V

4. 选择下一个发布版本号

   release="X.Y.Z"

5. 标记发布。需要带签名的GPG密钥

   git tag -s -m "nwb-docutils ${release}" ${release} origin/master

   然后推送

   git push origin ${release}

6. 创建源tar包和二进制wheels

   rm -rf dist/
   python setup.py sdist bdist_wheel

7. 将软件包上传到测试PyPI实例

   twine upload --sign -r pypitest dist/*

8. 检查PyPI测试软件包页面。

9. 将软件包上传到PyPI实例

   twine upload --sign dist/*

10. 检查PyPI软件包页面。

11. 创建虚拟环境，并确保可以安装软件包

    mkvirtualenv test-nwb-docutils-install
    pip install nwb-docutils

12. 清理

    deactivate
    rmvirtualenv test-nwb-docutils-install