Welcome to the Binero documentation!
We use the Sphinx framework to create and maintain this documentation.
Contributions most welcome!
All documentation uses the reStructuredText format 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 build/html directory
contains the built documentation.
Run tox run -e run to build the documentation and serve it locally
on http://localhost:8000 for preview.
We use Vale for linting and styling in our documentation. See the Vale documentation for installation and usage.
Please run Vale before creating a Pull Request to get suggestions on your prose.
you can use tox run -e vale to run Vale on the documentation.