Skip to content

README.md

Latest commit

 

History

History
37 lines (25 loc) · 1023 Bytes

README.md

File metadata and controls

37 lines (25 loc) · 1023 Bytes

Radon Documentation

This repository contains the MkDocs source for the public Radon documentation at radon-project.github.io/docs.

Deploy workflow Tests workflow

Local Development

# Clone the repository
git clone git@github.com:radon-project/docs.git radon-docs
cd radon-docs

# Create and activate a virtual environment
python -m venv .venv
.venv\Scripts\activate

# Install documentation dependencies
pip install -r requirements.txt

# Start the local docs server
mkdocs serve

The site will be available at http://127.0.0.1:8000/.

Scope

  • The source-based installation flow
  • The current CLI entrypoints in radon.py
  • The built-in functions exported by the interpreter
  • The modules currently shipped in stdlib/

License

This documentation is licensed under GNU GPL v3.