Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 809 Bytes

File metadata and controls

25 lines (17 loc) · 809 Bytes

pythonlings/docs/AGENTS.md

Scope

This guide applies to generated local documentation under pythonlings/docs/**. The root AGENTS.md also applies.

Generated Content

Do not edit index.json, topics/*.md, or NOTICE.md directly. They are generated by scripts/fetch_python_docs.py. The generator's SOURCES table defines the bundled topics, while info.toml holds exercise-facing documentation URLs.

Regenerate from the repository root:

python scripts/fetch_python_docs.py

Commit generator or source changes with their regenerated outputs. Review broad generated diffs because upstream Python documentation can change unrelated topics. Preserve the Python documentation licensing notice in NOTICE.md.

After regeneration, run python -m pytest tests/unit/test_docs.py -q.