This guide covers how to contribute to the core Red project.
The official home of this guide is https://red-devguide.readthedocs.io.
To build the documentation, you need to have Python 3.8
with venv
module installed on your machine.
You then can use make html
command which will create a virtual environment
under venv
subdirectory and automatically synchronize it with the dependencies
needed by this documentation.
To update dependencies, run make bumpdeps
.
To add new build dependencies, add them to appropriate file (requirements.in
for docs build requirements, dev-requirements.in
for dev requirements) and
run make compiledeps
to automatically update requirements.txt
appropriately.
See the LICENSE file for details.