This documentation is generated using mkdocs and mkdocs-material. The documentation is hosted on Github Pages.
Follow the instractions for local development setup.
# Clone the repo
git clone [email protected]:radon-project/docs.git radon-docs
# cd into the directory
cd radon-docs
# Create virtual envirenment
python3 -m venv .venv
# Activate the virtual environment (Windows)
.venv\Scripts\activate
# Activate the virtual environment (Linux or MacOS)
source .venv/bin/activate
# Install requirements
pip install -r requirements.txt
# Run mkdocs server
mkdocs serveThis documentation is Licensed under GNU GPL V3