How-to guides

How to install tinyDisplay

tinyDisplay uses Poetry to manage installation and dependencies.

Clone the tinyDisplay repository, and in the repository directory run:

poetry install

How to run tests

tinyDisplay’s test suite can be found in tests. The test suite requires Pytest, which is installed by default.

Execute pytest to run all tests.

How to build the documentation

The documentation is all in the project’s docs directory. The Makefile includes a number of useful commands that can be run in that directory.

Install documentation components locally in a virtualenv:

cd docs
make install

Build HTML:

make html
open _build/html/index.html

Or, run a documentation server:

make run

- the documentation will be served at http://localhost:8901

See also Documentation standards.