RoBorregos Official Documentation for the RoboCup@Home competition.
This documentation is based on mkdocs, using the material theme.
To run the documentation locally, you need to have python installed.
- Clone the repository
git clone https://github.com/RoBorregos/Home-Docs.git- Install the requirements
pip install -r requirements.txt
- Run the server
mkdocs serve- If you encounter issues with the command not being found try the following
python -m mkdocs serve- Open the browser and go to http://localhost:8000
Run formatting tests
pip install -r requirements_test.txt
# At root directory of project
pytest