Welcome to the Binero documentation!

We use the Sphinx framework to create and maintain this documentation.

Contributions are most welcome!

All documentation is using the reStructuredText format and is written in English. Open a Pull Request to the main branch.

Need help getting started? See Contributing to Projects

You need Python 3 and tox. Install tox with pip or use the package manager of your choice.

Run tox run -e docs to run sphinx-build. The built documentation will be in the build/html directory.

Run tox run -e run to build the documentation and serve it locally on http://localhost:8000 for preview.