{"id":16539713,"url":"https://github.com/rickstaa/unknown_type_placeholder_bug_ns","last_synced_at":"2025-06-19T22:36:21.593Z","repository":{"id":176568776,"uuid":"659138480","full_name":"rickstaa/unknown_type_placeholder_bug_ns","owner":"rickstaa","description":"Example repository to demonstrate the `WARNING: Unknown type: placeholder` bug that is thrown in AutoAPI when using it within a ROS package","archived":false,"fork":false,"pushed_at":"2023-06-27T08:40:50.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-14T07:24:28.648Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rickstaa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-27T08:04:58.000Z","updated_at":"2023-06-27T08:05:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"265fb768-9730-4e12-bd72-3e70560e5404","html_url":"https://github.com/rickstaa/unknown_type_placeholder_bug_ns","commit_stats":null,"previous_names":["rickstaa/unknown_type_placeholder_bug_ns"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickstaa%2Funknown_type_placeholder_bug_ns","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickstaa%2Funknown_type_placeholder_bug_ns/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickstaa%2Funknown_type_placeholder_bug_ns/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickstaa%2Funknown_type_placeholder_bug_ns/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rickstaa","download_url":"https://codeload.github.com/rickstaa/unknown_type_placeholder_bug_ns/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241773255,"owners_count":20018064,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-11T18:50:15.606Z","updated_at":"2025-03-04T02:45:05.898Z","avatar_url":"https://github.com/rickstaa.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unknown Type Placeholder bug\n\nThis is a simple example repository to demonstrate the `WARNING: Unknown type: placeholder` bug that is thrown in\nAutoAPI when using it within a ROS package (see https://github.com/readthedocs/sphinx-autoapi/issues/180).\n\n## Steps to Reproduce\n\n1.  Checkout the `bug` branch.\n2.  Install Python 3.8 (https://docs.python.org/3/).\n3.  Install the venv python package (i.e. `sudo apt install python3-venv`).\n4.  Create a new virtual environment using the `--system-site-packages` flag (i.e. `python3 -m venv test_pkg --system-site-packages`).\n5.  Install the python dependencies (i.e. `pip install -r requirements/doc_requirements.txt`).\n6.  Build the documentation from within the `docs` folder (i.e. `make html`).\n7.  Be greeted by the `WARNING: Unknown type: placeholder` bug.\n\n## How to debug autoapi to find the bug\n\n1.  Change the `\"program\": \"~/venvs/placeholder_bug/bin/sphinx-build\",` in the `.vscode/launch.json` file to point to your virtual environment's `sphinx-build` executable.\n2.  Put a breakpoint in the `lib/python3.9/site-packages/autoapi/mappers/python/mapper.py` file at line `333` (i.e. `children = {child[\"name\"]: child for child in module[\"children\"]}`).\n3.  Run the vscode debugger (i.e. `F5`).\n4.  See that the code overwrites the dictionary entry for a given module, here `test_pkg`, when a module is encountered for the second time.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickstaa%2Funknown_type_placeholder_bug_ns","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frickstaa%2Funknown_type_placeholder_bug_ns","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickstaa%2Funknown_type_placeholder_bug_ns/lists"}