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.
Using nwb-docutils to generate documentation for an extension: http://pynwb.readthedocs.io/en/latest/extensions.html#documenting-extensions
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/doctools/*: This package contains modules 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.
Available Notebooks
compare-hdf5-files.ipynb: This notebook illustrates how to compare hdf5 files.
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.
maintainers: how to make a release ?
Configure ~/.pypirc as described here.
Make sure the cli and module work as expected.
List all tags sorted by version
$ git fetch --tags && \ git tag -l | sort -V
Choose the next release version number:
release="X.Y.Z"
Tag the release. Requires a GPG key with signatures
git tag -s -m "nwb-docutils ${release}" ${release} origin/master
And push
git push origin ${release}
Create the source tarball and binary wheels
rm -rf dist/ python setup.py sdist bdist_wheel
Upload the packages to the testing PyPI instance
twine upload --sign -r pypitest dist/*
Check the PyPI testing package page.
Upload the packages to the PyPI instance:
twine upload --sign dist/*
Check the PyPI package page.
Create a virtual env, and make sure the package can be installed
mkvirtualenv test-nwb-docutils-install pip install nwb-docutils
Cleanup
deactivate rmvirtualenv test-nwb-docutils-install
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
Built Distribution
File details
Details for the file nwb_docutils-0.3.1.tar.gz
.
File metadata
- Download URL: nwb_docutils-0.3.1.tar.gz
- Upload date:
- Size: 1.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97042b435c3ae4e6be960bdb753fb573814a1b6f17d1b992c6342a50d1fd8ef0 |
|
MD5 | 652ecddf788f114405f0fc1d7bc010ec |
|
BLAKE2b-256 | 035d78e5bdda09d3c6bfd80ab7c2607c6d57e32bf46b56da516bbad867538bdf |
File details
Details for the file nwb_docutils-0.3.1-py2.py3-none-any.whl
.
File metadata
- Download URL: nwb_docutils-0.3.1-py2.py3-none-any.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfb1068dfefdf56a99eeca1a2d6246b01f941a7a2243b1af1856b7d8d22e2025 |
|
MD5 | 276ea369adee916a8a339881a02e83e3 |
|
BLAKE2b-256 | 1158901cef9624ff8ad1b93e37b099681aae14ceaea9d60ec7feebc0902526cd |