docs

Python

Python is used for general-purpose programming.

Installation

Install uv.

Usage

Initialization

uv init <name>
cd <name>

Dependencies

uv add <dep1> <dep2>
uv add <dep3> <dep4> --dev # dev dependencies

Dependencies

continued

sphinx-quickstart ./docs/ --ext-autodoc # Follow pyproject.toml version, author, etc.

Create

Edit

Run

VS Code Debugger, or:

uv run ./main.py

Docs

sphinx-apidoc -o ./docs/ ./
./docs/make.bat html

Do not need to run make if using Read the Docs

Upgrading

After upgrading, run:

uv tool upgrade --all
uv cache prune