Skip to main content

Collection of CLIs, scripts and modules useful to generate the NWB documentation

Project description

This project is under active development. Its content, API and behavior may change at any time. We mean it.


This project is a collection of CLIs, scripts and modules useful to generate the NWB documentation.


pip install nwb-docutils

Available Tools

  • nwb_generate_format_docs: Generate figures and RST documents from the NWB YAML specification for the format specification documentation.

  • nwb_init_sphinx_extension_doc: Create format specification SPHINX documentation for an NWB extension.

  • nwb_gallery_prototype

Available Modules

  • nwb_docutils/ This module is used to generate figures of the hierarchies of NWB-N files and specifications as well as to help with the programmatic generation of reStructuredText (RST) documents.


nwb-utils was initially a sub-directory of the nwb-schema project. Corresponding history was extracted during the 4th NWB Hackathon into a dedicated pip-installable project to facilitate its use by both core NWB documentation projects and various NWB extensions.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nwb_docutils-0.2.0.tar.gz (1.6 MB view hashes)

Uploaded Source

Built Distribution

nwb_docutils-0.2.0-py2.py3-none-any.whl (1.6 MB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page