René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"The current CONTRIBUTING.md is missing initialization of Git Submodule `cpython`","articleBody":"/type documentation\n\n## Which area/kind this task is related to?\n\n/type documentation\n\n## Task Description\n\nThe current Contributing.md is missing a critical step for local environment setup, leading to build failures. Specifically, when following the current instructions, the `cpython` directory remains empty because it is a Git Submodule that is not initialized by default.\n\nThis causes `pip install -r requirements.txt` to fail since it cannot find the referenced file `-r cpython/Doc/requirements.txt`.\n\nlogs:\n```txt\nERROR: Could not open requirements file: [Errno 2] No such file or directory: '/github/python-docs-el/cpython/Doc/requirements.txt'\n```\n\n**Proposed Changes:**\n\n#### **Option 1: Remote Requirements**\nIf we only need the dependency list without the full CPython source code, we can point `pip` directly to the official raw file.\n\nUpdate the first line of `requirements.txt` to:\n```text\n-r https://raw.githubusercontent.com/python/cpython/3.14/Doc/requirements.txt\n```\n\n#### **Option 2: Shallow Submodule Update**\nIf we prefer to keep the submodule for strict version locking (at commit afaa3b0), we should use a shallow clone. This downloads only the current files (~100MB) instead of the entire history.\n\nUpdate the `CONTRIBUTING.md` to submodule initialization to:\n\n```text\ngit submodule update --init --recursive --depth 1\n```\n","author":{"url":"https://github.com/leftkats","@type":"Person","name":"leftkats"},"datePublished":"2026-01-21T20:26:41.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/1129/python-docs-el/issues/1129"}