BUILDING.md

Building and distributing ITKPOCUS

We use flit and sphinx for distribution and documentation.

1. Setting up itkpocus to be live-installed in your venv

    # activate venv, i.e., source path/to/venv/Scripts/activate
    flit install --wrap-pth

Building and rendering Jupyter examples

1. Create the notebook in examples
2. Add a .nblink file to doc
3. Add .nblink file to doc/index.rst NOTE: steps #1 and #2 are necessary because examples is outside of the doc directory.

Building documentation

1. Documentation is built using sphinx, sphinx-napoleon, sphinx-apidoc, and the sphinxdoc html_theme.

    # assuming venv-3.7.6-itkpocus is the virtual environment
    source venv-3.7.6-itkpocus/Scripts/activate
    
    # brings in its local build of sphinx
    # exclude tests from doc
    sphinx-apidoc -f -o doc . 'tests'
    ./doc/make html

2. Note, all documentation will be rebuilt and deployed to readthedocs automatically on merge to master.

Running testing

1. python -m unittest or python tests/test_myfile.py

Publishing to PyPI

1. Update itkpocus/__init__.py version number
   1. Use rc for release candidates on major versions
   2. Use subversions for bugfixes
2. flit publish