Development

Build Documentation Locally

Install documentation dependencies:

pip install -r docs/requirements.txt

Build HTML pages:

cd docs
make html

On Windows, use:

cd docs
make.bat html

The generated site is written to docs/build/html.

Run Tests

ARTist tests use pytest. Install it in your development environment and run the focused test suite from the repository root:

pip install pytest
python -m pytest tests

Documentation Style

ARTist docstrings use NumPy-style sections:

Parameters
----------
name : type
    Description.

Returns
-------
type
    Description.

Examples
--------
>>> import artist
>>> result = obj.accessor.method(...)

When adding new accessor methods, include a short example that can be copied into a notebook.