Skip to content

binerogroup/documentation

Repository files navigation

Documentation

Welcome to the Binero documentation!

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

Contributions are most welcome!

Contributions

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

Build requirements

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

Building the documentation

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

Build and preview documentation locally

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