development.rst

Development and documentation

Install the package with development and documentation dependencies from the repository root:

python -m pip install -e ".[dev,docs]"

Run the package checks before opening a pull request:

python -m pytest tests -v
ruff check src tests
black --check src tests
mypy src/python_introspect --ignore-missing-imports

Documentation lives in docs/source. Build it from the repository root with fresh state and warnings treated as errors:

python -m sphinx -E -W --keep-going -b html docs/source docs/build/html

The documentation workflow is the maintained CI definition. See the repository for current tests and the issue tracker for bug reports.