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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file nwb_docutils-0.2.0.tar.gz.
File metadata
- Download URL: nwb_docutils-0.2.0.tar.gz
- Upload date:
- Size: 1.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9a668d8ffd3943809e20bd31ae34666d813d1a0b29062a0ba58a450492f7eaf5 |
|
| MD5 | 199ff1766a657ce3588cc326368cf49c |
|
| BLAKE2b-256 | 5a0aa24cbe06965a2d62cb19d69defbe55fa8b482f2aa34c9757e1bf8feb3a71 |
File details
Details for the file nwb_docutils-0.2.0-py2.py3-none-any.whl.
File metadata
- Download URL: nwb_docutils-0.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8a8e6554df3e50e2203d6cd4210f1b35668fad674ab533e0c0dac677094aac31 |
|
| MD5 | d2437ed05d7af23771e7d949fc5e6cc7 |
|
| BLAKE2b-256 | 0cbab334d08da188b3eecc8825bedfa0c6376a666cceeffb2dc59058a2de2cbe |
