Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

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.

Overview

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

Installation

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/render.py: 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.

History

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.

Filename, size & hash SHA256 hash help File type Python version Upload date
nwb_docutils-0.2.1-py2.py3-none-any.whl (1.6 MB) Copy SHA256 hash SHA256 Wheel py2.py3 Apr 11, 2018
nwb_docutils-0.2.1.tar.gz (1.6 MB) Copy SHA256 hash SHA256 Source None Apr 11, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page